AURORA IN DEVELOPMENT

DOCUMENTATION / DEVELOPERS

Developer guide

AURORA / DOCUMENTATION / EN

FOR DEVELOPERS

Start with the repository you are changing.

Aurora is developed across separate workstreams. This guide covers the public Aurora Website repository; it does not imply access to private repositories or describe unverified OS or browser APIs.

Repository scope

Website source: public GitHub repository. Aurora OS: private repository. The browser repository and its implementation details have not been verified by this website workstream.

Requirements

  • Node.js 22.22.0 or newer (the repository pins its version in .nvmrc).
  • npm, included with Node.js.
  • Git and access to the public website repository.

Clone and run locally

git clone https://github.com/Pokejoueur/aurora-website.git
cd aurora-website
git switch main
git switch -c feat/short-description
npm install
npm run dev

Open the local URL printed by Astro (normally http://localhost:4321). Keep your changes on a feature branch rather than committing directly to main.

Validate before opening a pull request

npm run check
npm run build
npm run preview

npm run check validates the public status registry and runs Astro checks. npm run build generates the static site in dist/. npm run preview serves that built output locally; it does not deploy the site.

Where to make changes

  • src/pages/en/ — English routes and page content.
  • src/layouts/ — shared page and documentation layouts.
  • src/styles/global.css — global design system and responsive styling.
  • src/data/status.json — public status claims and evidence references.
  • docs/ — architecture decisions, governance and website roadmap.
  • public/ — static assets and hosting headers.
  • .github/workflows/ci.yml — automated validation and build.

Contribution workflow

  1. Inspect the current branch, working tree, relevant page and existing conventions.
  2. Create a focused branch and make one coherent change.
  3. Keep product claims tied to evidence from the relevant product repository or test report.
  4. Run the validation commands and inspect the rendered pages at desktop and mobile widths.
  5. Review the complete diff for broken links, accessibility regressions, unsupported claims and unrelated changes.
  6. Open a pull request with its purpose, scope, validation results and known limitations.

Engineering references

Open the website repository ↗