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

Providing entire file github url in docs

Aperta
#25 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
help wanted
Lingua principale
JavaScript
Stelle
10
Fork
11
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Traccia il modo in cui l’ember app costruisce gli URL GitHub per la documentazione generata, iniziando dal percorso della dipendenza esterna node_modules/rsvp/index.js e dal caso analogo di inflector. Verifica che la documentazione generata contenga URL GitHub completi e funzionanti per queste dipendenze, così che l’app non debba più calcolarli.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.