feat: documentation site#31
Merged
Merged
Conversation
bryantbiggs
changed the title
Astro 6 static site deployed to GitHub Pages with section-scoped navigation (Docs / Registries / Design), right-side table of contents, previous/next page links, mobile hamburger menu, and lightning bolt logo with light/dark mode favicon variants. 20 pages covering getting started, configuration, CLI reference, Helm chart, performance, observability, FIPS 140-3, six registry guides, and five design documents (overview, sync engine, watch mode, benchmarks, findings).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation site for ocync built with Astro 6, deployed to GitHub Pages.
Site structure
Header nav: Docs | Registries | Design | GitHub
Each header tab scopes the left sidebar to its section (7 / 6 / 5 links). Right-side table of contents on pages with 3+ headings. Previous/next navigation at bottom of every doc page. Mobile hamburger menu. Custom 404 page.
Docs (7): Getting started, Configuration, CLI reference, Helm chart, Performance, Observability, FIPS 140-3
Registries (6): Amazon ECR, Docker Hub, GHCR, GAR, ACR, Chainguard
Design (5): Overview, Sync engine, Watch mode, Benchmarks, Findings
Design docs
5 focused documents (1,761 lines total). Overview covers the design narrative. Sync engine covers pipeline, AIMD, cache, staging, mounting, and 13 rejected alternatives with rationale. Watch mode covers discovery optimization. Benchmarks covers methodology. Findings covers current results and the optimization backlog.
Test plan
npm run buildsucceeds (20 pages)