Skip to content

feat: add learn section from idempot-js#4

Merged
mroderick merged 14 commits intomainfrom
add-learn-section
Apr 3, 2026
Merged

feat: add learn section from idempot-js#4
mroderick merged 14 commits intomainfrom
add-learn-section

Conversation

@mroderick
Copy link
Copy Markdown
Contributor

Summary

  • Import /learn/ section from idempot-js VitePress site to idempot.dev
  • Add Mermaid diagram support using vitepress-mermaid-renderer (VitePress 2.x compatible)
  • Create 5 educational pages about idempotency with framework context notes
  • Update navigation to replace "Why Idempotency" with "Learn" section
  • Remove old why-idempotency page (replaced by new learn section)

Changes

Infrastructure:

  • Added vitepress-mermaid-renderer dependency for Mermaid diagram rendering
  • Configured VitePress theme with Mermaid support (dark/light theme switching)

Content:

  • Created docs/learn/index.md - Learn section overview
  • Created docs/learn/why.md - Why idempotency matters (with mermaid diagrams, YouTube video)
  • Created docs/learn/duplicated-vs-repeated.md - Duplicated vs repeated operations (with Hono framework context)
  • Created docs/learn/client-key-strategies.md - Client key generation strategies
  • Created docs/learn/spec.md - IETF spec compliance (with idempot-js implementation context)

Navigation:

  • Updated top nav: "Why Idempotency" → "Learn"
  • Converted sidebar from array to object format for path-specific sidebars
  • Added /learn/ sidebar with 5 items
  • Updated / sidebar to show "Specifications" and "Projects"

Cleanup:

  • Removed old docs/why-idempotency.md page

Test Plan

  • Dev server starts without errors
  • All 5 learn pages accessible at /learn/*
  • Mermaid diagrams render correctly in both dev and production
  • YouTube video embed works
  • Sidebar navigation works for all pages
  • Top navigation "Learn" link works
  • Internal links between learn pages work
  • Code examples display with syntax highlighting
  • Production build succeeds
  • Production preview works correctly

Screenshots

The learn section includes:

  • Mermaid sequence diagrams showing duplicate request problems and idempotency solutions
  • Framework-specific code examples with context notes
  • Comprehensive coverage of idempotency concepts

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 3, 2026

Deploying website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3a26250
Status: ✅  Deploy successful!
Preview URL: https://e9646b9f.website-33l.pages.dev
Branch Preview URL: https://add-learn-section.website-33l.pages.dev

View logs

@mroderick mroderick force-pushed the add-learn-section branch from 5f39028 to 3a26250 Compare April 3, 2026 21:23
@mroderick mroderick merged commit f5ef6d3 into main Apr 3, 2026
3 checks passed
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