ember-learn / ember-learn/ember-jsonapi-docs

Cannot generate docs from local

オープン
#74 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
JavaScript
スター
10
フォーク
11
PR マージ指標
30日以内にマージされた PR はありません

説明

it looks like the updates over the past week have broken the ability for ember-jsonapi-docs to generate local api documentation. Not sure what is going on? Nothing appears for the new version in tmp/json-docs/ember or tmp/json-docs/ember-data

As a result, the generated version does not appear in the dropdown in ember-api-docs when running `yarn start:local`.

See also #70

Going back to commit 8a34672cffdd73fd2c1fa40139242f3af993b32a fixes that ability, although it hangs on downloading past versions.

This issue is holding up https://github.com/emberjs/data/pull/6449

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まずローカル生成フローを再現し、現在の動作をコミット 8a34672cffdd73fd2c1fa40139242f3af993b32d と比較します。tmp/json-docs/ember と tmp/json-docs/ember-data の下にある生成された出力を調べ、その後、yarn start:local の実行時に ember-api-docs がその出力をどのように使用するかを確認します。新しいローカルバージョンが生成され、ドロップダウンに表示され、#70 の関連作業を妨げなければ完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
build-system, documentation
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。