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

Providing entire file github url in docs

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

Beschreibung

At present in the ember app we construct the github url of a file by checking its project name and the appending the partial file url from the docs we generate. This doesn't handle scenarios where the docs refers to classes such as rsvp, inflector which are ember libraries that are external dependencies for ember & ember-data. In such cases the file url is defined as `node_modules/rsvp/index.js` which will be broken when user accesses it.

We should handle these scenarios & update the docs with a full & functional github url so that the ember app can just provide the link to the user without any computation at its end.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Verfolge, wie die ember app GitHub-URLs für generierte Dokumentation erstellt, beginnend mit dem Pfad für externe Abhängigkeiten node_modules/rsvp/index.js und dem analogen inflector-Fall. Überprüfe, dass die generierte Dokumentation vollständige, funktionsfähige GitHub-URLs für diese Abhängigkeiten enthält, sodass die App sie nicht mehr berechnen muss.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 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.