Skip to content

fix: docs formatting and anchors#4491

Open
dfinityianblenke wants to merge 7 commits intomasterfrom
fix/sdk-docs-formatting-and-anchors
Open

fix: docs formatting and anchors#4491
dfinityianblenke wants to merge 7 commits intomasterfrom
fix/sdk-docs-formatting-and-anchors

Conversation

@dfinityianblenke
Copy link
Contributor

@dfinityianblenke dfinityianblenke commented Mar 4, 2026

Description

Fix formatting issues and broken anchor links across multiple CLI reference documentation files.

Changes by file:

  • dfx-killall.mdx: Page title incorrectly said "dfx stop" instead of "dfx killall"
  • dfx-cache.mdx: Broken anchor links (#_dfx_cache_list, #_dfx_cache_show) in command table
  • dfx-nns.mdx: Broken anchor links (#_dfx_nns_import, #_dfx_nns_install) in command table and inline reference
  • dfx-sns.mdx: Broken anchor links in command table, missing bash language tag on code block
  • dfx-completion.mdx: Trailing dash character in table header separator
  • dfx-cycles.mdx: Malformed table in redeem-faucet-coupon arguments section
  • dfx-wallet.mdx: All tables used non-standard format (missing pipe delimiters on separator rows), reformatted to valid markdown

How Has This Been Tested?

Documentation-only changes. Verified anchor links match Docusaurus-generated heading IDs and all markdown tables render correctly.

Checklist:

  • The title of this PR complies with Conventional Commits.
  • I have edited the CHANGELOG accordingly.
  • I have made corresponding changes to the documentation.

lwshang and others added 6 commits January 15, 2026 10:53
Signed-off-by: Linwei Shang <linwei.shang@dfinity.org>
Signed-off-by: Linwei Shang <linwei.shang@dfinity.org>
- dfx-killall.mdx: Fix incorrect page title (was "dfx stop", now "dfx killall")
- dfx-cache.mdx: Fix broken anchor links in command table
- dfx-nns.mdx: Fix broken anchor links in command table and inline reference
- dfx-sns.mdx: Fix broken anchor links in command table, add missing bash
  language tag on code block
- dfx-completion.mdx: Fix trailing dash in table header separator
- dfx-cycles.mdx: Fix malformed table in redeem-faucet-coupon arguments
- dfx-wallet.mdx: Fix all malformed tables (missing pipe delimiters on
  separator rows) across command table, options, arguments, and flags sections

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dfinityianblenke dfinityianblenke requested a review from a team as a code owner March 4, 2026 19:08
@lwshang lwshang changed the title Fix/sdk docs formatting and anchors fix: docs formatting and anchors Mar 4, 2026
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.

2 participants