From 96d35db4be4f46580288d5096c93a593f0f969eb Mon Sep 17 00:00:00 2001 From: sven Date: Sat, 1 Nov 2025 10:30:39 +0100 Subject: [PATCH] Clean up landing page and consolidate contributing content 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 --- docs/contributing/index.md | 29 +++++++++++++++++++++++++++++ docs/index.md | 25 ++++++++++++++++++------- 2 files changed, 47 insertions(+), 7 deletions(-) diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 7d8dc99..4493a01 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -172,4 +172,33 @@ Always test your changes before submitting: - Ensure the site builds without errors - Test the search functionality with your new content +## Community & Recognition + +### Contributors + +Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/contributors) who have helped make this resource better - you rock! 🎉 + +Your contributions help the entire documentation community by: +- Making tools more discoverable +- Sharing knowledge and best practices +- Keeping information current and accurate +- Building a comprehensive resource for everyone + +### Recognition + +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! + +## License & Legal + +This project is licensed under [CC0 1.0 Universal](https://github.com/testthedocs/awesome-docs/blob/main/LICENSE). + +### What This Means +- **Public Domain**: This work is in the public domain +- **No Rights Reserved**: You can copy, modify, distribute and perform the work +- **Commercial Use**: You can use this work for commercial purposes +- **No Attribution Required**: Though attribution is appreciated, it's not required + +### Contributing Agreement +By contributing to this project, you agree that your contributions will be licensed under the same CC0 1.0 Universal license. + Thank you for contributing to Awesome Docs! 🎉 \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 356a4a1..60be49a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ A **curated list** of awesome documentation tools, guides and best practices for - **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](https://github.com/testthedocs/awesome-docs/blob/master/CONTRIBUTING.md) +- **Get Started**: Check our [Getting Started Guide](./guide) to learn how to use this resource ## 📋 Categories Overview @@ -29,17 +29,28 @@ A **curated list** of awesome documentation tools, guides and best practices for - [GitHub Actions](./github-actions/) - Automation for documentation workflows - [Analytics](./analytics/) - Understanding your documentation usage -### � Learning Resources +### 📚 Learning Resources - [Style Guides](./style-guides/) - Documentation and writing style guides - [Reading List](./reading/) - Articles and resources about documentation - [Best Practices](./best-practices/) - Proven strategies and approaches -## 🤝 Contributing +## 🎯 Popular Tools -We welcome contributions! Please see our [contribution guidelines](https://github.com/testthedocs/awesome-docs/blob/master/CONTRIBUTING.md) for details. +### For Beginners +- **[Docusaurus](https://docusaurus.io/)** - React-based documentation platform +- **[VitePress](https://vitepress.dev/)** - Vue-powered static site generator +- **[MkDocs](https://www.mkdocs.org/)** - Python-based documentation generator -Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/contributors) - you rock! 🎉 +### For API Documentation +- **[Swagger/OpenAPI](https://swagger.io/)** - Industry standard for API docs +- **[ReDoc](https://redocly.github.io/redoc/)** - Beautiful API documentation +- **[Postman](https://www.postman.com/)** - API development and documentation -## 📄 License +### For Quality Assurance +- **[Vale](https://vale.sh/)** - Syntax-aware linter for prose +- **[Alex](https://github.com/get-alex/alex)** - Catch insensitive writing +- **[lychee](https://github.com/lycheeverse/lychee)** - Fast link checker -This project is licensed under [CC0 1.0 Universal](https://github.com/testthedocs/awesome-docs/blob/master/LICENSE). \ No newline at end of file +--- + +*Found a tool that should be included? [Contribute to this project](./contributing/) and help make documentation better for everyone!* \ No newline at end of file