​
Astro Documentation Integration

This guide describes how to integrate the backend documentation with the Astro-based platform site.

​
🚀 Integration Approach

​
Mintlify Structure

We use Mintlify to manage our documentation from the root docs/ directory. The structure is mapped automatically based on the folder hierarchy and registered in docs/docs.json. Root Structure: 
docs/
├── backend/
│   ├── go/            # Go Backend microservices
│   └── bun/           # Bun Backend (TypeScript)
├── frontend/
│   ├── astro/         # Astro Platform frontend
│   └── solidstart/    # SolidStart frontend
└── shared/            # Shared logic and UI docs

​
📝 Naming Conventions

All documentation files use lowercase with hyphens (kebab-case) to ensure clean, web-standard URLs.
  • ✅ architecture.md
  • ✅ cqrs-leave-management.md
  • ✅ better-auth-integration.md

​
🎨 Layouts & Frontmatter

Every markdown file must include frontmatter pointing to a common layout: 
---
title: "My Documentation"
description: "Summary of content"
---

​
🔍 Automation

We use the Documentation Manager skill to automate:
  • Index Generation: Every category has an index.md listing its files.
  • Link Validation: Ensuring no dead links exist between documents.
  • Style Consistency: Maintaining a uniform look and feel.