documentation.md

Documentation

Documentation Changes

Documentation improvements are always welcome:

• Fix typos and improve clarity
• Add examples and tutorials
• Update outdated information
• Translate documentation

Documentation Structure

• README.md - Project overview and quick start
• docs/developer/ - Developer documentation
  • frontend/ - Frontend development guides
  • backend/ - Backend development guides
  • contributing/ - Contributing guidelines
• CLAUDE.md - AI assistant development guide
• Code comments - Complex logic and APIs

Writing Good Documentation

• Use clear, concise language
• Include code examples
• Provide context for why, not just what
• Keep it up to date with code changes
• Use proper markdown formatting