Skip to content

docs: add changelog page with timeline UI and walrus-sites source - #3587

Open
jessiemongeon1 wants to merge 2 commits into
mainfrom
jessie/changelog-page
Open

docs: add changelog page with timeline UI and walrus-sites source#3587
jessiemongeon1 wants to merge 2 commits into
mainfrom
jessie/changelog-page

Conversation

@jessiemongeon1

Copy link
Copy Markdown
Contributor

Summary

  • Add a /changelog page with a timeline UI, product filters (Walrus, Walrus Memory, Walrus Sites), and search
  • Pull releases from three GitHub sources: MystenLabs/walrus, MystenLabs/MemWal, and MystenLabs/walrus-sites
  • Show editorial summaries as primary content with linked PR improvements below
  • Update generate-release-notes.js to output changelog.json for the React page component
  • Replace "Release Notes" navbar link with "Changelog" pointing to /changelog

Test plan

  • Verify /changelog renders the timeline with all three product categories
  • Verify filter buttons correctly show/hide entries by product
  • Verify search filters entries by title and description
  • Verify editorial summaries display for entries that have them
  • Verify linked improvements point to correct GitHub PRs
  • Verify light and dark mode styling

🤖 Generated with Claude Code

…ilters

Add a /changelog page with a timeline UI matching the new design:
- Filter by product (Walrus, Walrus Memory, Walrus Sites)
- Search across titles, descriptions, and changes
- Editorial summaries with linked PR improvements
- Three GitHub release sources: walrus, MemWal, walrus-sites

Update generate-release-notes.js to also output changelog.json
for the React page component. Navbar updated to link to /changelog.

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

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://MystenLabs.github.io/walrus/pr-preview/pr-3587/

Built to branch gh-pages at 2026-07-27 22:46 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions

Copy link
Copy Markdown
Contributor

📋 afdocs check results

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

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

Agent-Friendly Docs Check: https://MystenLabs.github.io/walrus/pr-preview/pr-3587/
Timestamp: 7/27/2026, 10:48:42 PM

content-discoverability
  ✗ llms-txt-exists: No llms.txt found at any candidate location (https://MystenLabs.github.io/walrus/pr-preview/pr-3587/llms.txt, https://mystenlabs.github.io/llms.txt, https://mystenlabs.github.io/docs/llms.txt)
      Learn more: https://agentdocsspec.com/spec/#llms-txt-exists
  ○ llms-txt-valid: Skipped: dependency check did not pass
  ○ llms-txt-size: Skipped: dependency check did not pass
  ○ llms-txt-links-resolve: Skipped: dependency check did not pass
  ○ llms-txt-links-markdown: Skipped: dependency check did not pass
  ✗ llms-txt-directive-html: Could not test any pages; 1 failed to fetch
      Learn more: https://agentdocsspec.com/spec/#llms-txt-directive-html
  ✗ llms-txt-directive-md: Could not fetch markdown for any of 1 pages; 1 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/1 tested)
      Learn more: https://agentdocsspec.com/spec/#markdown-url-support
  ✗ content-negotiation: Server ignores Accept: text/markdown header (0/1 pages return markdown)
      Learn more: https://agentdocsspec.com/spec/#content-negotiation

page-size
  ✓ rendering-strategy: All 1 pages contain server-rendered content
  ○ page-size-markdown: Skipped: dependency check did not pass
  ✓ page-size-html: All 1 pages under 50K chars (median 21K HTML → 822 markdown (96% boilerplate))
  ⚠ content-start-position: 1 of 1 pages have content starting at 10–50% (worst 43%)
      Learn more: https://agentdocsspec.com/spec/#content-start-position

content-structure
  ✓ tabbed-content-serialization: No tabbed content detected across 1 pages
  ✓ section-header-quality: No tabbed content found; header quality check not applicable
  ○ markdown-code-fence-validity: Site does not serve markdown content; nothing to analyze

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

observability
  ○ llms-txt-coverage: Skipped: dependency check did not pass
  ○ markdown-content-parity: Skipped: dependency check did not pass
  ✓ cache-header-hygiene: All 1 endpoints have appropriate cache headers

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

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

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

@jessiemongeon1

jessiemongeon1 commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

Style Guide Audit

Audited 4 file(s) against the Sui Documentation Style Guide.

33 violation(s) found. All must be fixed before merge.

docs/content/release-notes.mdx (2 violation(s))

2 violation(s) (2 regex, 0 claude)

  • Line 15 — No em dashes in prose
    • Current:
    • Fix: Rewrite with comma, parentheses, or split sentence
  • Line 19 — No em dashes in prose
    • Current:
    • Fix: Rewrite with comma, parentheses, or split sentence

docs/content/release-notes/walrus-platform.mdx (15 violation(s))

15 violation(s) (15 regex, 0 claude)

  • Line 325 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 453 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 456 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 457 — Use "through" not "via"
    • Current: via
    • Fix: through
  • Line 475 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 478 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 541 — Use "through" not "via"
    • Current: via
    • Fix: through
  • Line 558 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 562 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 563 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 564 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 766 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 766 — "on-chain" is one word → "onchain"
    • Current: on-chain
    • Fix: onchain
  • Line 768 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 856 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb

docs/content/release-notes/walrus-sites.mdx (16 violation(s))

16 violation(s) (16 regex, 0 claude)

  • Line 21 — Capitalize testnet in prose
    • Current: testnet
    • Fix: Testnet
  • Line 44 — Capitalize testnet in prose
    • Current: testnet
    • Fix: Testnet
  • Line 46 — Use "through" not "via"
    • Current: via
    • Fix: through
  • Line 97 — Capitalize testnet in prose
    • Current: testnet
    • Fix: Testnet
  • Line 106 — Use "through" not "via"
    • Current: via
    • Fix: through
  • Line 106 — "on-chain" is one word → "onchain"
    • Current: on-chain
    • Fix: onchain
  • Line 108 — No em dashes in prose
    • Current:
    • Fix: Rewrite with comma, parentheses, or split sentence
  • Line 108 — "on-chain" is one word → "onchain"
    • Current: on-chain
    • Fix: onchain
  • Line 161 — Use "and" not "&"
    • Current: &
    • Fix: and
  • Line 321 — No Latin abbreviations
    • Current: e.g.
    • Fix: for example
  • Line 372 — Capitalize mainnet in prose
    • Current: mainnet
    • Fix: Mainnet
  • Line 398 — No exclamation marks
    • Current: !
    • Fix: .
  • Line 400 — Use "through" not "via"
    • Current: via
    • Fix: through
  • Line 400 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 402 — Use second person (you), not first person
    • Current: We are committed to following [semantic versioning
    • Fix: Rewrite using 'you'
  • Line 1 — Frontmatter needs keywords
    • Current: (missing or placeholder)
    • Fix: Add relevant keywords

Automated audit using the Sui Documentation Style Guide.

Convert CRLF to LF in walrus-sites.mdx and add generated changelog.json
to the editorconfig ignore list.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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