Skip to content

docs(book): fix nested codeblock fence in first-command step 3#1936

Open
uinstinct wants to merge 1 commit into
coleam00:devfrom
uinstinct:fix/docs-first-command-nested-codeblock
Open

docs(book): fix nested codeblock fence in first-command step 3#1936
uinstinct wants to merge 1 commit into
coleam00:devfrom
uinstinct:fix/docs-first-command-nested-codeblock

Conversation

@uinstinct

@uinstinct uinstinct commented Jun 9, 2026

Copy link
Copy Markdown

Summary

  • Problem: The Step 3 codeblock in the /book/first-command docs used 3-backtick fences, which broke when a nested ```bash block appeared inside it. Markdown terminated the outer fence early, causing the rest of the instructions to render as raw text.
  • Why it matters: New users following the book see garbled/broken instructions for creating their first command.
  • What changed: Changed the outer fence from 3 backticks to 4 backticks (markdown ... ) so the inner 3-backtick bash block nests correctly.
  • What did not change (scope boundary): No content changes; no other pages touched.

UX Journey

Before

User opens /book/first-command → scrolls to Step 3 → sees broken markdown rendering after the bash codeblock.

After

User opens /book/first-command → scrolls to Step 3 → sees the full nested codeblock rendered correctly.

Architecture Diagram

Before

N/A — single markdown file change.

After

N/A — single markdown file change.

Connection inventory

From To Status Notes
docs-web first-command.md modified fence depth fix

Label Snapshot

  • Risk:
  • Size:
  • Scope:
  • Module:

Change Metadata

  • Change type:
  • Primary scope:

Linked Issue

Validation Evidence (required)

  • Evidence provided (test/log/trace/screenshot): Visual inspection of the markdown file confirms correct nesting.
  • If any command is intentionally skipped, explain why: No code changes; lint-staged Prettier passed on commit.

Security Impact (required)

  • New permissions/capabilities? ()
  • New external network calls? ()
  • Secrets/tokens handling changed? ()
  • File system access scope changed? ()

Compatibility / Migration

  • Backward compatible? ()
  • Config/env changes? ()
  • Database migration needed? ()

Human Verification (required)

  • Verified scenarios: Read the fixed markdown section to confirm the outer fence spans the entire block including the inner bash snippet.
  • Edge cases checked: N/A
  • What was not verified: N/A

Side Effects / Blast Radius (required)

  • Affected subsystems/workflows: None.
  • Potential unintended effects: None.
  • Guardrails/monitoring for early detection: N/A

Rollback Plan (required)

  • Fast rollback command/path: Revert the single commit.
  • Feature flags or config toggles (if any): None.
  • Observable failure symptoms: N/A

Risks and Mitigations

None.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Fixed formatting of code example in the Getting Started guide to ensure proper rendering.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9425359a-b774-40d3-8c9a-67e1adbc2885

📥 Commits

Reviewing files that changed from the base of the PR and between d72c20c and 286b2ab.

📒 Files selected for processing (1)
  • packages/docs-web/src/content/docs/book/first-command.md

📝 Walkthrough

Walkthrough

Documentation fix in first-command.md for the "Step 3: Write the Instructions" section. The embedded markdown code block example uses adjusted fence delimiters (different backtick counts on opening and closing fences) to prevent premature termination of the surrounding code block.

Changes

Documentation fence delimiter correction

Layer / File(s) Summary
Markdown fence delimiter adjustment
packages/docs-web/src/content/docs/book/first-command.md
Fenced code block delimiters in the embedded markdown example are updated by changing the backtick count on both opening and closing fences to ensure correct rendering without prematurely terminating the surrounding content.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • coleam00/Archon#1218: Similar fenced code block backtick count adjustment in documentation to fix Markdown rendering.

Poem

🐰 A fence misaligned, backticks askew,
Now balanced and neat, the doc renders true.
Delimiters dancing in ticks of just right,
The markdown shines bright in its corrected light! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: fixing a nested codeblock fence issue in the first-command documentation.
Description check ✅ Passed The description comprehensively covers all critical sections including problem statement, UX journey, validation evidence, and security/compatibility assessments, though some template fields lack values.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant