fix: clear remaining afdocs content-start, fence, and parity fails - #551
Conversation
Expand Supported Wallets, drop the commented Atlas fence, and unwrap MDX widgets so markdown matches HTML on the five failing pages. Co-authored-by: Cursor <cursoragent@cursor.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Files |
There was a problem hiding this comment.
Pull request overview
This PR updates several documentation pages to resolve afdocs parity and formatting failures by replacing MDX widgets with plain Markdown, removing problematic commented content, and expanding/clarifying key guide sections so rendered HTML and source .md align.
Changes:
- Replaced MDX components (DocCardList, Tabs, Steps, Accordion) with plain Markdown lists/headings to improve parity.
- Removed an HTML-commented ASCII fence in the Atlas getting-started guide that afdocs treated as unclosed.
- Expanded/clarified content in PowPeg supported wallets and several developer guides to satisfy afdocs content-start and parity checks.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/06-use-cases/interoperability/index.md | Replaces DocCardList with explicit Markdown implementation-guide links and adds spacing for clearer parsing. |
| docs/05-dev-tools/dev-environments/index.md | Adds a Markdown list of supported environments ahead of the existing CardsGrid. |
| docs/04-resources/07-hackathon/index.md | Replaces Tabs-based prerequisites with Markdown sections for beginners/experienced developers. |
| docs/04-resources/06-guides/powpeg-app/advanced-operations/supported-wallets.md | Expands “supported wallets” into structured sections, steps, and related links. |
| docs/04-resources/06-guides/atlas/getting-started-atlas.md | Removes the commented ASCII diagram containing a fenced code block. |
| docs/02-developers/05-smart-contracts/06-rsk-cli/introduction.md | Replaces Accordion widget with Markdown headings and bullet lists; removes “Smart Bitcoin” wording. |
| docs/02-developers/04-quickstart/dynamic.md | Replaces Steps/Tabs MDX with Markdown headings and lists; fixes dashboard image alt text typo. |
Suppressed comments (1)
docs/02-developers/04-quickstart/dynamic.md:193
- Like the install step above, these two commands are alternatives; presenting them as separate blocks without “choose one” guidance can lead to users running both and getting conflicting lockfiles/scripts.
Start the development server using Bun or Yarn.
```bash
bun dev
</details>
---
💡 <a href="/rsksmart/devportal/new/main?filename=.github/skills/code-review/SKILL.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add a `code-review` agent skill</a> or configure MCP servers for context-aware, tailored reviews. <a href="https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review#mcp-servers-and-agent-skills" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn more in the docs.</a>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.
Suppressed comments (4)
docs/02-developers/04-quickstart/dynamic.md:189
- The dev-server commands are shown as two separate code blocks, which can read like both should be run. Combining them into a single fenced block with a clear "or" makes the instruction unambiguous.
```bash
bun dev
**docs/04-resources/06-guides/powpeg-app/advanced-operations/supported-wallets.md:27**
* This section says Trezor is supported for peg-in only, but there is also a documented Trezor peg-out flow. Updating this sentence avoids implying Trezor can’t be used for peg-out.
Trezor is supported for peg-in. Unlock the device, open the Bitcoin account you will use, and follow Performing a peg-in using Trezor.
**docs/02-developers/04-quickstart/dynamic.md:148**
* The install commands are formatted as an indented code block, which loses syntax highlighting and is inconsistent with the fenced command blocks used elsewhere in this guide. Use a fenced bash block so the commands render consistently.
This issue also appears on line 187 of the same file.
Install the necessary dependencies with either Bun or Yarn (choose one).
bun install
# or
yarn install
**docs/04-resources/06-guides/powpeg-app/advanced-operations/supported-wallets.md:21**
* This section says Ledger is supported for peg-in only, but there is also a documented Ledger peg-out flow. Updating this sentence avoids implying Ledger can’t be used for peg-out.
This issue also appears on line 27 of the same file.
Ledger is supported for peg-in. Set a PIN, install the Bitcoin app, and follow Performing a peg-in using Ledger.
</details>
Summary
.mdmatches HTML on Dynamic, rsk-cli intro, Dev Environments, Hackathon, and Interoperability.Test plan
/resources/guides/powpeg-app/advanced-operations/supported-wallets/has hardware/software sections and related links./resources/guides/atlas/getting-started-atlas/has no```inside HTML comments.###feature headings and does not say Smart Bitcoin.npx afdocs check https://dev.rootstock.io --fixes --verbose(this run still samples production).Made with Cursor