GitHub Pages Deployment

Aegis includes a GitHub Pages deployment in .github/workflows/docs.yml.

The docs site is built from docs/ with Jekyll. Keep repository docs public-safe; customer-specific notes and long-form planning artifacts should live outside this repo.

Local Preview

Build the site locally:

npm run docs:build

Serve the site locally:

npm run docs:serve

Then open:

http://127.0.0.1:4000/

The local serve command clears the GitHub Pages base URL so links work from localhost.

Enable Pages

In the GitHub repository settings:

1. Open Settings.
2. Open Pages.
3. Set Build and deployment source to GitHub Actions.
4. Save the setting.

The workflow builds Markdown files under docs/ with GitHub’s Jekyll Pages action and deploys the generated site when documentation changes land on main.

For a private repository, GitHub Pages availability depends on the repository owner’s GitHub plan and visibility settings. If Pages is unavailable while the repository is private, the workflow remains ready and can be enabled when the repository is made public.

Published Content

The public documentation build includes:

• architecture docs;
• operations runbooks;
• legal/licensing docs;
• the documentation index.

Do not add customer-specific notes or internal planning archives to docs/. If a planning artifact contains reusable product guidance, rewrite it as public-safe setup, architecture, or operations documentation before committing it.

Manual Deploy

Use the Documentation workflow’s workflow_dispatch trigger to deploy manually after Pages is enabled.