Logical Architecture

The logical architecture of @frame/astro prioritizes simplicity in content authoring and efficiency in distribution.

Directory structure

Documents live in src/content/docs/ and are organized hierarchically so the built-in search system can index them effectively.

[!TIP] @frame/astro uses Astro’s Content Collections to ensure every document satisfies the metadata schemas required by Starlight.

Starlight

Starlight is a documentation system for Astro that makes it easy to create high-quality technical docs. It provides a smooth reading experience and advanced search tooling through Starlight.

Internationalization

@frame/astro supports i18n so documentation can ship in multiple languages. The default canonical language is Spanish and lives in src/content/docs. Additional languages live in src/content/docs/{lang} where {lang} is the language code. For example, German would be stored in src/content/docs/de. Active locales are configured in astro.config.ts.

Keeping additional locales is optional, since they can be translated via GitHub Actions (docs-translator.yml).

src/content/docs/
├── introduction.mdx
└── en/
    ├── introduction.mdx
    └── ...

Document names and their folders determine the URL, and they must match across all languages so Astro can recognize alternate versions of a document.