Skip to main content

Contributing Documentation

Documentation standards​

  • Clear and concise - Write for developers of all skill levels
  • Code examples - Include practical, runnable examples
  • Up-to-date - verify examples work with the current version
  • Well-organized - Use proper headings and structure

Documentation types​

Documentation Structure
docs/
├── concept/            # Core concept explanations
├── api/                # API reference and best practices
├── tutorials/          # Step-by-step tutorials
├── advanced-guides/    # Advanced tutorials
├── guides/             # How-to guides and best practices
├── contribution/       # How to contribute to Refract
└── troubleshooting/    # How to resolve common issues

Writing guidelines​

  • Use active voice and present tense
  • Include code examples for all concepts
  • Add interactive demos when possible
  • Explain why something works, not just how
  • Keep examples focused and practical