Skip to main content

Documentation Platform Overview

This section covers the management and development of our Docusaurus-powered documentation platform.

🎯 Platform Features​

Modern Documentation​

  • Docusaurus v4: Latest documentation framework
  • Responsive Design: Works on all devices
  • Fast Search: Comprehensive content search
  • Version Management: Track documentation versions

Developer Experience​

  • Live Reload: Instant preview during development
  • Markdown Support: Easy content creation
  • Component Integration: Custom React components
  • Theme Customization: Branded experience

🛠️ Technology Stack​

Core Framework​

  • Docusaurus: Documentation site generator
  • React: Component framework
  • TypeScript: Type safety
  • MDX: Enhanced Markdown

Features​

  • Auto-generated Sidebars: From folder structure
  • Blog Integration: Announcements and updates
  • Versioning: Historical documentation
  • SEO Optimization: Search engine friendly

📚 Documentation Structure​

Our documentation is organized by application:

  • Shared: Cross-project documentation
  • DAGGH: Frontend application docs
  • ML Service: Machine learning service docs
  • API: API reference documentation

Learn more: Check out the Setup Guide and Best Practices.