Documentation Index
This document provides a comprehensive index of all documentation available in this project.
📚 Published Documentation Site
URL: https://mvwestendorp.github.io/quarto-review-extension/
The documentation site is automatically deployed via GitHub Actions on every push to main.
🗂️ Documentation Structure
User Documentation (docs/user/)
End-user guides and tutorials for using the Quarto Review extension.
Developer Documentation (docs/dev/)
Technical documentation for contributors and developers.
Getting Started
Architecture & Design
Testing
Planning & Roadmaps (dev/planning/)
Analysis & Quality (dev/analysis/)
Security (dev/security/)
API Reference (docs/generated/api/)
Auto-generated TypeDoc API documentation.
- Generated from source code JSDoc comments
- Updated automatically on every build
- Available at: https://mvwestendorp.github.io/quarto-review-extension/api/
Quality Reports (docs/generated/coverage/)
Test coverage and quality metrics.
- Coverage reports generated by Vitest
- Updated automatically on every test run
- Available at: https://mvwestendorp.github.io/quarto-review-extension/coverage/
📦 Archive (docs/archive/)
Historical documentation and legacy notes (not published to GitHub Pages):
- Archive README - Overview of archived documentation
- GitHub Pages Setup (
archive/github-pages/) - GitHub Pages deployment documentation
- Translation Planning (
archive/translation-planning/) - Historical translation module plans
See archive/README.md for complete details.
Root-level project documentation:
🔄 Automatic Updates
The following documentation is automatically regenerated and deployed:
On Every Push to Main:
- ✅ API Reference (TypeDoc)
- ✅ Test Coverage Reports
- ✅ Documentation site deployment
Manual Updates Required:
- User guides and tutorials
- Architecture documentation
- Implementation plans
- Coverage statistics in
docs/index.html
📝 Contributing to Documentation
To Update User/Developer Docs:
- Edit files in
docs/user/ or docs/dev/
- Use clear, concise language
- Include code examples where appropriate
- Test all links
- Submit PR for review
To Update API Docs:
- Update JSDoc comments in TypeScript source
- Follow JSDoc best practices
- Include parameter descriptions and return types
- Add usage examples where helpful
Documentation Standards:
- Use Markdown format
- Follow existing structure and style
- Include table of contents for long documents
- Use relative links within the docs
- Add descriptive alt text for images
🔗 External Resources
- GitHub Repository: https://github.com/mvwestendorp/quarto-review-extension
- Issue Tracker: https://github.com/mvwestendorp/quarto-review-extension/issues
- CI/CD Pipeline: https://github.com/mvwestendorp/quarto-review-extension/actions
- Security Dashboard: https://github.com/mvwestendorp/quarto-review-extension/security
📊 Documentation Coverage
Current documentation status:
| Category |
Coverage |
Status |
| User Guides |
6 docs |
✅ Complete |
| Developer Guides |
6 docs |
✅ Complete |
| API Reference |
Auto-gen |
✅ Automated |
| Test Coverage |
Auto-gen |
✅ Automated |
| Architecture |
Active docs |
✅ Streamlined |
| Feature Plans |
5 docs |
🚧 In Progress |
Last Updated: 2025-12-26
Documentation Version: 0.1.0