Skip to content

docs: fix walrus-memory MCP sidebar and broken links#3473

Merged
jessiemongeon1 merged 5 commits into
mainfrom
fix/docs-build-issue
Jun 17, 2026
Merged

docs: fix walrus-memory MCP sidebar and broken links#3473
jessiemongeon1 merged 5 commits into
mainfrom
fix/docs-build-issue

Conversation

@jessiemongeon1

Copy link
Copy Markdown
Contributor

Summary

  • Update sidebarsWalrusMemory.js to replace stale mcp/quick-start and mcp/how-it-works entries with the actual per-client MCP doc pages (claude-code, claude-desktop, cursor, opencode, codex, antigravity, reference, changelog)
  • Update KNOWN_PAGES in transform-walrus-memory-docs.js so internal links in fetched MCP docs are correctly rewritten with the /walrus-memory/ prefix

The upstream MemWal repo restructured its MCP docs, which broke the docs site build and caused links on live walrus-memory pages to redirect to non-existent pages.

Test plan

  • pnpm build passes in docs/site/
  • Verified no unrewritten internal links remain in walrus-memory-content/

🤖 Generated with Claude Code

jessiemongeon1 and others added 4 commits June 4, 2026 10:37
…mpt contrast

Add redirect entries to ws-resources.manual.json for the legacy
/usage/interacting.html path, pointing to /docs/walrus-client.
Covers all variants (bare, .html, /index, /docs/ prefix).

Also improve "Copy prompt" button contrast in dark mode by using
--ifm-heading-color for text and --ifm-color-emphasis-500 for border.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…lors

Use #faf8f5 text and rgba borders for dark mode via [data-theme='dark']
selectors, matching the site's body text color for reliable contrast.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Use dark text (#1c2228) on the light teal primary background so the
"Open in agent" button is legible in dark mode.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-06-17 15:54 UTC

@github-actions

github-actions Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

📋 afdocs check results

URL: https://MystenLabs.github.io/walrus/pr-preview/pr-3473/

Running checks on mystenlabs.github.io/walrus/pr-preview/pr-3473/...

Agent-Friendly Docs Check: https://MystenLabs.github.io/walrus/pr-preview/pr-3473/
Timestamp: 6/17/2026, 3:44:46 PM

content-discoverability
  ✓ llms-txt-exists: llms.txt found at https://MystenLabs.github.io/walrus/pr-preview/pr-3473/llms.txt
  ✓ llms-txt-valid: llms.txt follows the proposed structure (H1, blockquote, heading-delimited link sections)
  ⚠ llms-txt-size: llms.txt is 54,726 characters (between 50,000 and 100,000; consider splitting)
      Learn more: https://agentdocsspec.com/spec/#llms-txt-size
  ○ llms-txt-links-resolve: llms.txt contains 160 links, but none are under /walrus/pr-preview/pr-3473
  ○ llms-txt-links-markdown: llms.txt contains 160 links, but none are under /walrus/pr-preview/pr-3473
  ✓ llms-txt-directive-html: llms.txt directive found in HTML of all 167 pages, near the top of content
  ✗ llms-txt-directive-md: Could not fetch markdown for any of 167 pages; 167 had no markdown version
      Learn more: https://agentdocsspec.com/spec/#llms-txt-directive-md

markdown-availability
  ✗ markdown-url-support: No pages support .md URLs (0/167 tested)
      Learn more: https://agentdocsspec.com/spec/#markdown-url-support
  ✗ content-negotiation: Server ignores Accept: text/markdown header (0/167 pages return markdown)
      Learn more: https://agentdocsspec.com/spec/#content-negotiation

page-size
  ✓ rendering-strategy: All 167 pages contain server-rendered content
  ○ page-size-markdown: Skipped: dependency check did not pass
  ✓ page-size-html: All 167 pages under 50K chars (median 41K HTML → 8K markdown (80% boilerplate))
  ✗ content-start-position: 24 of 167 pages have content starting past 50% (worst 71%)
      Learn more: https://agentdocsspec.com/spec/#content-start-position

content-structure
  ✓ tabbed-content-serialization: 53 tab group(s) across 30 of 167 pages; all serialize under 50K chars
  ✓ section-header-quality: 2 page(s) with tab headers checked; headers include variant context
  ✓ markdown-code-fence-validity: All 0 code fences properly closed across 1 pages

url-stability
  ✓ http-status-codes: All 167 pages return proper error codes for bad URLs
  ✓ redirect-behavior: No redirects detected across 167 pages

observability
  ✗ llms-txt-coverage: llms.txt covers 0/159 sitemap doc pages (0%); 159 missing
      Learn more: https://agentdocsspec.com/spec/#llms-txt-coverage
  ○ markdown-content-parity: Skipped: dependency check did not pass
  ✓ cache-header-hygiene: All 168 endpoints have appropriate cache headers

authentication
  ✓ auth-gate-detection: All 167 pages are publicly accessible
  ○ auth-alternative-access: All docs pages are publicly accessible; no alternative access paths needed

Summary
  12 passed, 1 warnings, 5 failed, 5 skipped (23 total)

Full spec: https://agentdocsspec.com/spec/

…rom upstream

Replace hardcoded KNOWN_PAGES and sidebar with dynamic generation so the
docs build stays in sync automatically when the upstream MemWal repo adds,
removes, or reorganizes pages.

- transform script: build known pages set by scanning cache files at build
  time instead of maintaining a manual list
- sidebar: parse docs.json (Mintlify config) from the fetched cache to
  generate Docusaurus categories, with orphan pages auto-appended to
  matching categories by directory prefix

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jessiemongeon1 jessiemongeon1 merged commit 33b9168 into main Jun 17, 2026
31 checks passed
@jessiemongeon1 jessiemongeon1 deleted the fix/docs-build-issue branch June 17, 2026 15:53
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