Repository navigation
fix(docs): make the docs site build again (MDX error in a spec) - #40
Conversation
…s again
The docs-site build has failed on every run since 2026-07-24 with "MDX compilation
failed for file docs/specs/review-json-recovery.md ... Could not parse expression
with acorn". An inline code span wrapped across a line break, so the compiler read
the `{ ... }` inside it as a JavaScript expression. With no successful build, the
published site has been stuck on the 2026-07-23 content. Joining the span onto one
line fixes it; a confined local `docusaurus build` now succeeds and the built pages
include the one-line install.
Signed-off-by: claude-code <claude-code@users.noreply.github.com>
Agent: claude-code (Sonnet 5.5) (automated, instructed-by: welsbach)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
ASDD review - advisory (recommendation:
A single-line formatting fix that joins an inline code span split across two lines in a spec markdown file, resolving an MDX compilation failure that has blocked docs deployment since 2026-07-24. The semantic content of the spec is unchanged; only the line wrapping differs. No correctness, security, or conformance concerns arise from this change. | Adversarial pass: This PR is a single-line fix that joins a code span split across two lines in a docs spec, resolving an MDX parse error that has blocked the docs site build since 2026-07-24. The change removes a line break and adds nothing-no new abstraction, no duplication, no scaffolding. Net complexity is negative. The joined line is long (~200 chars in source), but that is a trivial aesthetic concern in a markdown file and does not affect rendering or correctness. I could not construct a strong argument for blocking or reworking this PR; it is the simplest possible fix for the stated problem and the author reports a verified clean build. Security scan (deterministic + SAST): no new issues. Impact scan: 1 finding(s), 0 block. CODE - ok
SECURITY - ok
SPEC - ok
IMPACT - ok
QUALITY - ok
Generated by the ASDD advisory review. Mode: |
What & why
The docs site has not published since 2026-07-23.
docs-deployhas failed on every run since 2026-07-24 (the last success wascb94d6b), soonehillai.github.io/ASDDstill shows July's content. The install guide from #39, and everything else merged since, never reached it. The build fails at:An inline code span in that file wraps across a line break (
`def f()then{ ... }on the next line). The MDX compiler does not keep the span together, reads the{ ... }as a JavaScript expression, and stops. This PR joins the span onto one line. It is the only change.Spec: the file it edits,
docs/specs/review-json-recovery.md, which is a spec underspec_paths; the content is unchanged.How
One line:
(`def f()\n{ ... }`, `{x: 1}`)becomes(`def f() { ... }`, `{x: 1}`). I scanned the other files underdocs/for braces outside code and found no other instance.Verified by running the real build, not by reading: a copy of the repo with this change,
npm ciandnpm run buildindocs-site, confined (OS sandbox, writes limited to a temp folder,HOMEand the npm cache redirected into it). Result:[SUCCESS] Generated static files in "build", and the builtdeploy,adopt-govern,operate-gooseandslash-commandspages contain the install command. The build still prints "broken link" warnings for old relative links to files outsidedocs/(for example../../AGENTS.md); they are warnings, existed before this, and do not fail the build.After merge,
docs-deployruns onmainand should publish the site. If it fails again, the next error will be in that run's log.Disclosure (required: ASDD §1)
below and each agent commit carries the
Agent:trailer.Change scope (required: ASDD framework-impact lens)
standard's text or any behaviour adopters rely on for conformance.
Checklist
Signed-off-by: Name <email>(usegit commit -s).This project follows ASDD: agents disclose,
humans approve merges, security and quality are gates.