Documentation Tooling Project (Docusaurus Site)
This project involved auditing and restructuring documentation for daily.dev using Docusaurus to create a clean, scalable, and user-friendly docs-as-code workflow.
Improved Pages
- getting-started: introduces users to daily.dev
- quick-start: guides them through the quick start process.
- Browser Extension Installation Guide: Step-by-step instructions on how to install the daily.dev browser extension. Made step headings scannable and action-oriented.
- PWA Installation Guide: Step-by-step instructions on how to install the daily.dev PWA. Made step headings scannable and action-oriented.
Improvements Included
- Simplified Navigation: Placed the Quick Start section in its own page for easier navigation.
- Shorter Steps: Simplified the Browser Extension Installation and PWA Installation guides by making it more action-oriented and scannable.
- Increase user buy-in: Explained why daily.dev is a great place for developers to learn, share, and network.
Challenges
- Auditing daily.dev's current documentation
- Restructuring improved versions for scalability while keeping it beginner-friendly.
What I Learnt
- How to implement a Docs-as-Code workflow using Docusaurus.
- To not get stuck in the auditing process and just start working