- Notifications
You must be signed in to change notification settings - Fork 948
Closed as not planned
Labels
Description
To improve the contributor experience and make the project more accessible to new users, any ideas to improve documentations are welcome
Current Documentation
The project currently has:
README.md
- Main project overview and basic usageCONTRIBUTING.md
- Contribution guidelinesCODE_OF_CONDUCT.md
- Community guidelinesSECURITY.md
- Security policyllm.txt
- text based Instructions for AI agents
Areas for Improvement
-
User documentation:
- Detailed CLI usage examples
- Python API documentation with examples
-
Developer documentation:
- Architecture overview and component relationships
- Code organization and module responsibilities
- Development setup and workflow
Let's use this Issue to discuss, do not hesitate to add your ideas