mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-19 11:18:18 -05:00
sven
edbcb85587
- Restructured homepage with clear category overview - Created comprehensive Site Generators page with detailed tool descriptions - Built API Documentation page covering tools, testing, and best practices - Added Quality Assurance page with linting, testing, and accessibility tools - Updated navigation with organized tool categories and resources - Enhanced sidebar with logical content grouping - Transformed flat README list into searchable, navigable documentation New structure: - Core Tools: Site Generators, API Documentation - Content & Quality: Writing Tools, Quality Assurance - Resources: Style Guides, Reading List, GitHub Actions - Getting Started: Introduction, Installation All content now properly categorized and easily discoverable through navigation and search.
2.1 KiB
2.1 KiB
Awesome Docs
A curated list of awesome documentation tools, guides and best practices for creating, maintaining, and improving documentation.
If you see a package or project here that is no longer maintained or is not a good fit, please submit a pull request to improve this file. Thank you!
🚀 Quick Start
- Browse by Category: Use the navigation menu to explore specific tool categories
- Search: Use the search function to find specific tools or topics
- Contributing: Check our contribution guidelines
📋 Categories Overview
🛠️ Core Tools
- Site Generators - Static site generators for documentation
- API Documentation - Tools for API documentation and testing
- Editors - Markdown and documentation editors
🎨 Content Creation
- Writing Tools - Grammar, style, and writing assistance
- Visual Tools - Screenshots, screencasts, and mockups
- Quality Assurance - Linting, testing, and validation
🌐 Publishing & Hosting
- Hosting Platforms - Places to host your documentation
- GitHub Actions - Automation for documentation workflows
- Analytics - Understanding your documentation usage
� Learning Resources
- Style Guides - Documentation and writing style guides
- Reading List - Articles and resources about documentation
- Best Practices - Proven strategies and approaches
🤝 Contributing
We welcome contributions! Please see our contribution guidelines for details.
Thanks to all contributors - you rock! 🎉
📄 License
This project is licensed under CC0 1.0 Universal.