Documentation

Documentation Guidelines

• Use Markdown format for documentation
• Use headings, lists, and code blocks for clarity
• Include diagrams using Mermaid syntax where applicable
• Use the README.md as the primary documentation entry point
• Keep documentation in sync with code changes at all times

/docs Directory

• Place all project documentation in the docs directory
• Use subdirectories for major sections (e.g., docs/architecture, docs/api, docs/user-guide)
• Each subdirectory should have an index.md file as the main entry point
• Use relative links to connect documentation files within the docs directory

README.md Structure

The project README.md should contain:

• Project overview and purpose
• Quick start guide with prerequisites
• Setup instructions (dev environment, dependencies)
• Architecture diagrams
• Links to other relevant documentation
• Troubleshooting section