Open
Description
Migrate typed-express-router documentation to Docusaurus
Background
The current API TS documentation is spread across multiple sources including GitHub READMEs and the Docusaurus site. We need to centralize comprehensive documentation in Docusaurus while minimizing README content to essentials to eliminate redundancy.
Task Description
Migrate documentation from @api-ts/typed-express-router
package README to the Docusaurus site following the Diátaxis framework.
Migration Plan
A detailed migration plan has been created in typed-express-router-migration-plan.md
that outlines:
- What content to keep in the README
- What content to migrate to Docusaurus
- How to structure the migrated content according to the Diátaxis framework (tutorials, how-to guides, explanation, reference)
- Implementation priorities
Implementation Steps
- Create reference documentation for typed-express-router in Docusaurus
- Update or create tutorial content that includes typed-express-router
- Create how-to guides for specific use cases
- Add explanation content about typed-express-router's role in the ecosystem
- Update the README to remove duplicated content and link to Docusaurus
Related
- Issue chore: add test for decoding overlapping keys with flatten #21 (Documentation migration)
Metadata
Metadata
Assignees
Labels
No labels