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

Cannot generate docs from local

Offen
#74 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
10
Forks
11
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, den lokalen Generierungsablauf zu reproduzieren und das aktuelle Verhalten mit dem Commit 8a34672cffdd73fd2c1fa40139242f3af993b32d zu vergleichen. Untersuche die generierte Ausgabe unter tmp/json-docs/ember und tmp/json-docs/ember-data und prüfe anschließend, wie ember-api-docs diese Ausgabe beim Ausführen von yarn start:local verwendet. Erledigt ist die Aufgabe, wenn eine neue lokale Version generiert wird und im Dropdown erscheint, ohne die damit verbundene Arbeit in #70 zu blockieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
build-system, documentation
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.