Official guides, examples and reference for building with Orionis Framework.
English documentation • Spanish documentation • API reference • Website
This repository maintains the official documentation for Orionis Framework, an async-first, full-stack Python framework for web applications, APIs and real-time services.
Published at docs.orionis-framework.com in English and Spanish, the manual covers installation, HTTP, realtime, MCP, the ORM, security, application services, testing and deployment. The site is built with Astro and Starlight.
The API reference is generated separately from the framework's Python docstrings.
Use Node.js 22 and npm, matching the deployment environment. Install dependencies from the committed lockfile:
git clone https://github.com/orionis-framework/docs.git
cd docs
npm ci
npm run devOpen the local URL printed by Astro. Edit the Markdown guides in src/content/docs/en/ and src/content/docs/es/ to update the manual.
Corrections, clearer examples and translation improvements are welcome. Start with the contribution guide.
- Keep the English and Spanish guides synchronized, including API signatures, examples and links.
- When adding or moving a page, update the page catalog and navigation. Preserve existing page IDs and keep each page in a single navigation group.
- Match frontmatter titles to the catalog, keep
editUrl: true, and use absolute documentation paths with the appropriate language prefix, such as/en/http/routing. - Run the checks below and preview your changes on desktop and mobile before opening a pull request.
| Command | Purpose |
|---|---|
npm run docs:test |
Test the catalog, navigation, translations and contributor data. |
npm run docs:validate |
Validate source pages, titles, routes, internal links and heading fragments. |
npm run build |
Generate the static site and validate the rendered HTML, links, translations, sitemap and search index. |
npm run preview |
Serve the generated site locally for review. |
| Path | Contents |
|---|---|
| src/content/docs/ | English and Spanish Markdown guides. |
| src/pages/ | Custom Astro pages, including contributor listings. |
| src/components/, src/plugins/, src/styles/, src/utils/ | Shared components, Markdown processing, styles and site utilities. |
| config/ | Page catalog and navigation order. |
| public/ | Logo, images, local fonts, scripts and crawler configuration. |
| scripts/ | Tests and documentation validation tools. |
The GitHub Actions workflow runs the tests, builds and validates the site, and publishes it to GitHub Pages when changes are pushed to master.
Generated output (dist/, .astro/), installed dependencies (node_modules/) and local environment files are excluded from version control through .gitignore.
Released under the MIT license. Bundled font licenses are available in public/fonts/.