Add static docs site and un-gate build-docs CI#6
Merged
Conversation
Scaffold docs-site/ as a Next.js static-export site (output: 'export', emits out/). Pages: overview, getting started, architecture, and GitOps + canary, all sourced from the README and docs/architecture.md. Pin next to an exact 15.4.x patch and commit package-lock.json so npm ci is reproducible. Remove the if: false gate from the build-docs job in ci.yml now that docs-site/ exists, and link the site from the README.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
infra/ installs only kube-prometheus-stack (Prometheus, Grafana, Alertmanager) for observability. Loki, Tempo, and Promtail are never installed by make up, so the docs site and README over-claimed them as working. Soften every mention to roadmap framing or remove it: - architecture: drop bogus Loki child from the app-of-apps list; reduce observability table to the real Metrics signal, add a Roadmap note - home: drop Logs/Traces component rows, add roadmap note - getting-started: Grafana shows Prometheus metrics; logs/traces roadmap - README: tagline, components table (logs/traces moved under Roadmap heading), surfaces line, mermaid diagram all corrected
The gh-pages deploy 403'd (GITHUB_TOKEN was read-only) and ran on PRs. Scope contents:write to this job, and gate the deploy step to push-on-main so PRs build (validate) without publishing.
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.
What
Adds a real static documentation site under
docs-site/and removes theif: falsegate from thebuild-docsjob in.github/workflows/ci.yml, so the job now runs on push and PR.docs-site
A minimal Next.js static-export site:
next.config.mjssetsoutput: 'export', sonext buildemitsdocs-site/out/.nextpinned to an exact15.4.xpatch;react/react-dompinned exact.package-lock.jsoncommitted sonpm ciis reproducible.Pages, all sourced from the existing
README.mdanddocs/architecture.md(no fabricated features):make up, the component table.make up, hosts entries, surfaces, Makefile targets, known limits.Verified locally:
npm ci && npm run buildproducesdocs-site/out/index.htmlplus a page per route.CI
build-docsrunsnpm ci && npm run buildindocs-site/, then deploysdocs-site/outto gh-pages viapeaceiris/actions-gh-pages@v4. On a PR the build validates only; the deploy step runs on push to the default branch.