ember-learn / ember-learn/ember-cli-addon-docs
`docs/route.js` Presence Causes API Documentation To Not Be Found/Error
- Vorherrschende Sprache
- JavaScript
- Sterne
- 172
- Forks
- 142
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
I always use Ember's generators, even when creating my Dummy app's routes. Every time that I spun up `ember-cli-addon-docs` I'd translate the _getting started_ instructions to the `ember generate ...` commands.
This caused me to run an `ember g --dummy route docs` which politely creates my `template.hbs` and `route.js`. What I discovered was that if the `route.js` was present, my API documentation in the sidebar would only show up if I started at the `application-index` route and navigated directly to the docs route.
1. When the `docs` route would refresh, my API doc links in the sidebar would disappear.
1. If I was viewing a specific api-doc page and reloaded it, I'd get the following error: `Error while processing route: docs.api.item Cannot read property 'get' of null TypeError: Cannot read property 'get' of null`.
The fix for this was for me to remove my empty `docs/route.js`.
We might want to mention this in the _getting started_ documentation for `ember-cli-addon-docs` but even more we might want to fix this. I don't feel that the mere presence of an empty `docs/route.js` should somehow impede the `model()` hook from firing.
_I am happy to fork and fix this if someone knows what might be the ailing cause and can point me in the correct direction._ I too am happy to update the getting started section of your docs with this warning message.
Thanks again for this addon.
Beitragsleitfaden
Rechercherichtung
Beginne damit, das Verhalten mit einer leeren docs/route.js zu reproduzieren, und vergleiche es dann mit der funktionierenden Konfiguration, in der diese Datei entfernt wurde. Verfolge, warum die docs-Route verhindert, dass der model()-Hook API-Dokumentation bereitstellt, und bestätige, dass Sidebar-Links und das direkte Neuladen von API-Dokumentationsseiten funktionieren, wenn die Datei vorhanden ist; erwäge, die Getting-Started-Dokumentation um den Hinweis zu ergänzen, falls sich das Verhalten nicht beheben lässt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- web-dev
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100