mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-21 04:03:48 -05:00
sven
96d35db4be
Landing page improvements: - Removed Contributing and License sections for cleaner focus - Updated Quick Start to remove external GitHub links - Added Popular Tools section with beginner-friendly recommendations - Organized tools by category (Beginners, API Documentation, QA) - Added subtle call-to-action footer linking to contributing page - Improved navigation flow to keep users on the documentation site Contributing page enhancements: - Merged license information from landing page - Added comprehensive Community & Recognition section - Included contributor acknowledgments and impact explanation - Added detailed license explanation (CC0 1.0 Universal) - Clarified contributing agreement and licensing terms - Enhanced getting help and community sections Benefits: - Landing page is now focused on discovering and using tools - All contributor/legal information consolidated in one place - Better user flow from discovery to contribution - Cleaner separation of concerns between user and contributor content - Maintained important information while improving organization
2.5 KiB
2.5 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
- Get Started: Check our Getting Started Guide to learn how to use this resource
📋 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
🎯 Popular Tools
For Beginners
- Docusaurus - React-based documentation platform
- VitePress - Vue-powered static site generator
- MkDocs - Python-based documentation generator
For API Documentation
- Swagger/OpenAPI - Industry standard for API docs
- ReDoc - Beautiful API documentation
- Postman - API development and documentation
For Quality Assurance
Found a tool that should be included? Contribute to this project and help make documentation better for everyone!