Add docs validation script#2
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c7d4909dee
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
carldebilly
left a comment
There was a problem hiding this comment.
Good idea overall — this encodes the invariants from the recent MCP docs reviews (--no-build, repl-contacts-sample, VS Code servers shape, Repl.Mcp wording) as executable checks. One logic error and a couple of coordination notes below.
Cross-repo note: this validator consecrates --no-build + a prior dotnet build as the canonical host-config form. The yllibed/repl repo (PR #37) currently documents plain dotnet run in the sample README and configs/*.json — those should be aligned to the same form, otherwise the repo and the website will document two different shapes for the same sample.
|
Review round addressed. Changes pushed:
Verification:
I replied to each inline review thread individually. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ccae366fa3
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
autocarl's token lacked the workflow scope needed to push .github/workflows changes; adding the workflow proposed in this PR's description now that a token with that scope is available. Runs on pull_request, push to main, and workflow_dispatch: npm ci, then npm run docs:validate, then an Astro build to catch build regressions. Claude-Session: https://claude.ai/code/session_01AopmWBr1VknLrUqerBEWsB
The workflow proposed in the PR description ran 'npm run astro -- build' directly, which fails: ApiRef.astro imports src/generated/api-reference.json, a file only produced by 'docs:api' from DocFX metadata over the Repl source (confirmed failing in the initial run of this workflow). Mirror the Repl source checkout, .NET setup, and DocFX install already proven in .github/workflows/deploy.yml, then run 'npm run build' (which chains docs:api -> astro build) instead of building Astro alone. Keep 'docs:validate' as an early, fast-failing step before the heavier checkout. Claude-Session: https://claude.ai/code/session_01AopmWBr1VknLrUqerBEWsB
Summary
npm run docs:validatefor Repl/MCP documentation invariants.dotnet runhost launches and VS Codeserversshape requirements.Verification
npm run docs:validate— passed, 37 files checked.git diff --check— passed.ASTRO_TELEMETRY_DISABLED=1 XDG_CONFIG_HOME=/workspace/.config npm run astro -- build— passed, 36 pages built.Follow-up needed for CI wiring
I attempted to include the read-only PR workflow and to remove the daily Pages deploy schedule, but the current
autocarltoken only has thereposcope. GitHub rejected pushes that modify.github/workflows/*without theworkflowscope:So this PR intentionally contains the script only. With a token/account that has the
workflowscope, the CI wiring should add this workflow:Daily deployment note
The daily deployment is caused by
.github/workflows/deploy.yml:If daily deploys are not useful, remove that
scheduleblock. Deploys will still happen onpushtomain,workflow_dispatch, andrepository_dispatchfrom Repl releases.