Skip to content

docs: how to improve our docs? #325

@cyclotruc

Description

@cyclotruc

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 usage
  • CONTRIBUTING.md - Contribution guidelines
  • CODE_OF_CONDUCT.md - Community guidelines
  • SECURITY.md - Security policy
  • llm.txt - text based Instructions for AI agents

Areas for Improvement

  1. User documentation:

    • Detailed CLI usage examples
    • Python API documentation with examples
  2. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussionCommunity talk on a given topic

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions