charhub-documentation-patterns

What problem does it solve?

Define and standardize how CharHub code is documented, ensuring every API, component, and service has co-located, template-based docs with consistent structure and naming.

Core Features & Use Cases

• Documentation philosophy and rationale for co-located docs alongside code
• Clear naming conventions and templates for backend services/docs, controllers, Vue components, and composables
• Practical usage patterns and checklists to ensure documentation quality and consistency

Quick Start

Create a new .docs.md file next to your code file following the documented naming conventions and templates.