Skip to content

fix(docs): make the docs site build again (MDX error in a spec) - #40

Merged
welsbach merged 1 commit into
mainfrom
fix/docs-site-mdx-build
Oct 22, 2026
Merged

welsbach merged 1 commit into
mainfrom
fix/docs-site-mdx-build

Conversation

@asdd-agent

@asdd-agent asdd-agent Bot commented Oct 22, 2026

Copy link
Copy Markdown

What & why

The docs site has not published since 2026-07-23. docs-deploy has failed on every run since 2026-07-24 (the last success was cb94d6b), so onehillai.github.io/ASDD still shows July's content. The install guide from #39, and everything else merged since, never reached it. The build fails at:

Error: MDX compilation failed for file ".../docs/specs/review-json-recovery.md"
Cause: Could not parse expression with acorn   (line 9, column 2)

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 under spec_paths; the content is unchanged.

How

One line: (`def f()\n{ ... }`, `{x: 1}`) becomes (`def f() { ... }`, `{x: 1}`). I scanned the other files under docs/ 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 ci and npm run build in docs-site, confined (OS sandbox, writes limited to a temp folder, HOME and the npm cache redirected into it). Result: [SUCCESS] Generated static files in "build", and the built deploy, adopt-govern, operate-goose and slash-commands pages contain the install command. The build still prints "broken link" warnings for old relative links to files outside docs/ (for example ../../AGENTS.md); they are warnings, existed before this, and do not fail the build.

After merge, docs-deploy runs on main and should publish the site. If it fails again, the next error will be in that run's log.

Disclosure (required: ASDD §1)

  • Authored by a human.
  • Authored or co-authored by an AI agent under human direction. The agent identity is named
    below and each agent commit carries the Agent: trailer.

Agent identity (if any): asdd-agent (GitHub App), work by claude-code (Sonnet 5.5) · Instructed by (human handle): welsbach

Change scope (required: ASDD framework-impact lens)

  • Non-normative: a fix, docs, chore, or reference-implementation change that does NOT change the
    standard's text or any behaviour adopters rely on for conformance.
  • Normative

Checklist

  • Commits are signed off (DCO): Signed-off-by: Name <email> (use git commit -s).
  • Conventional Commit message(s).
  • Change scope declared above; if normative, the impact analysis and target version are filled in.
  • Quality gates pass locally (lint / types / tests as applicable): the docs build.
  • If this touches a protected path, a named human owner is requested for review. It touches no protected path; CODEOWNERS still requests @welsbach.
  • Docs shipped with the change: this change is a docs fix.

This project follows ASDD: agents disclose,
humans approve merges, security and quality are gates.

…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-agent
asdd-agent Bot requested a review from welsbach as a code owner October 22, 2026 10:12
@asdd-agent asdd-agent Bot added the fix label Oct 22, 2026
@github-actions

Copy link
Copy Markdown

ASDD review - advisory (recommendation: comment)

Produced by an automated agent under human direction. Advisory only: a human approves and merges.
Nothing here merges automatically.

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

  • note: The diff is a pure formatting fix: a code span previously split across two lines is joined onto one line. The text content is byte-identical apart from the removed newline and indentation. No logic, no API surface, no edge cases to evaluate.

SECURITY - ok

  • note: No security-relevant changes: no secrets, no dangerous sinks, no dependency or CI/workflow modifications. The PR body describes a local sandboxed build for verification but introduces no changes to protected paths.

SPEC - ok

  • note: The edited file docs/specs/review-json-recovery.md is a spec under spec_paths, and the spec is present and linked in the PR body. The change is chore-level trivial (joining a line break inside an inline code span) and does not alter the spec's normative content, requirements, or acceptance criteria. No scope creep or missing requirements detected.

IMPACT - ok

  • note: Non-normative. The change is purely editorial formatting in a spec markdown file; it does not edit normative text (STANDARD.md, standards/**, CONFORMANCE.md) or governance rules, and does not change any gate verdict, lens contract, agent fixed prompt, or the meaning of a MUST. The author's 'Non-normative' declaration matches this classification. No impact analysis or version target is required.
  • note: No normative text or behavioural surface touched; classified non-normative.

QUALITY - ok

  • note: The joined line is now quite long in source (~200 chars). If the project enforces a markdown line-length style, a maintainer may want to reflow the surrounding paragraph instead, but this does not affect rendering or correctness.
  • note: Adversarial refutation: I genuinely cannot find a strong reason to block this PR. It is a minimal, content-preserving fix that makes the docs build pass. The only adjacent concern-pre-existing broken-link warnings for relative paths like ../../AGENTS.md-is out of scope and correctly noted as pre-existing by the author. A human should confirm the build log claim if they want, but the change itself is sound.

Generated by the ASDD advisory review. Mode: live.

@welsbach welsbach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check

@welsbach
welsbach merged commit 5508b78 into main Oct 22, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants