Host auto generated `typedoc` docs for JS SDK on Github Pages
- Lingua principale
- TypeScript
- Stelle
- 1
- Fork
- 21
- Merge medio
- 12h 14m
- PR unite (30g)
- 41
Descrizione
As of now, the auto-generated `typedoc` md files are not hosted anywhere and can be found inside of the `docs/typedoc` folder. To improve dev-ex, we should host the docs on Github Pages and update all links and references inside of the exported docs to correctly link to the typedoc docs.
Furthermore, the new hosted docs should also be appropriately integrated in the NPM README.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
The typedoc markdown files are already generated in docs/typedoc/. Look at the repository's GitHub Pages settings and workflow files to understand how docs are currently deployed. Update any configuration to deploy from that folder, then verify links within the generated docs work correctly. Finally, update the npm README to point to the new hosted URL.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- developer-experience, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 65/100