docs: v0.16 release notes and versioned docs#508
Conversation
- Write comprehensive what's-new page for 0.16 covering breaking changes (KurrentDB migration, StreamEvent.Revision rename, .NET 8/9/10 targets, tracing metadata field changes), new features (SQLite event store, Azure Service Bus, source generators, checkpoint initial position, PostgreSQL gap handling, performance optimizations), and bug fixes - Add Azure Service Bus infrastructure documentation - Restore full RabbitMQ and SQL Server docs for v0.16 (were stubs) - Add checkpoint initial position section to subscription docs - Archive v0.15 docs into versioned 0.15/ directory - Promote next/ content to current (v0.16 Stable) - Reset next/ as empty placeholder for future updates - Fix relative paths for component imports and internal links Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Deploying eventuous-main with
|
| Latest commit: |
9c916c7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6239fb56.eventuous-main.pages.dev |
| Branch Preview URL: | https://docs-v0-16-release-notes.eventuous-main.pages.dev |
Review Summary by QodoSet up v0.16 release documentation with versioning and comprehensive feature coverage
WalkthroughsDescription• Comprehensive v0.16 release notes documenting 40+ PRs with breaking changes, new features, and bug fixes • Set up versioned documentation structure: v0.16 as current stable, v0.15 archived, Preview as placeholder • Updated all v0.16 docs to use KurrentDB naming (from EventStoreDB) with corresponding class/package renames • Created complete v0.15 archived documentation with EventStoreDB naming and original API patterns • Added new feature documentation: Azure Service Bus infrastructure, SQLite checkpoint store, checkpoint initial position (StartFrom option) • Restored full RabbitMQ and SQL Server documentation for v0.15 (previously stubs) • Streamlined command API documentation with clearer examples and simplified structure • Refactored aggregate store docs focusing on multi-tier architecture • Updated documentation configuration to reflect v0.16 as stable version with v0.15 versioning support • Fixed relative links and import paths across versioned documentation structure • Minor formatting fixes and typo corrections throughout documentation Diagramflowchart LR
A["v0.16 Current<br/>KurrentDB naming"] -->|"Stable"| B["Root docs"]
C["v0.15 Archived<br/>EventStoreDB naming"] -->|"Historical"| D["0.15/ directory"]
E["Preview<br/>Placeholder"] -->|"Future"| F["next/ directory"]
B --> G["New Features:<br/>Azure Service Bus<br/>SQLite checkpoint<br/>Source generators"]
B --> H["Breaking Changes:<br/>KurrentDB migration<br/>StreamEvent.Revision<br/>.NET 8/9/10"]
D --> I["Original v0.15<br/>API patterns<br/>Full RabbitMQ/SQL docs"]
File Changes1. docs/src/content/docs/whats-new.mdx
|
Code Review by Qodo
1.
|
Add docs/DOCS_VERSIONING.md with detailed versioning structure, relative path rules, and release process. Reference it from CLAUDE.md using progressive disclosure so it's only loaded when docs work is needed. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
/diagnostics route for current docs
This link now points to /diagnostics, but this commit moved the diagnostics landing page to 0.15/diagnostics/index.mdx and leaves current docs with only diagnostics/details.md, so users following subscription docs hit a 404 in v0.16. The same broken target is also referenced in docs/src/content/docs/subscriptions/subs-diagnostics.md, so either restoring a current diagnostics/index page or updating these links to /diagnostics/details is needed.
The archived 0.15 intro links to ../persistence, but this commit does not add a 0.15/persistence/index page, so that navigation target resolves to a missing route. The same dead target appears in other new 0.15 pages (for example 0.15/prologue/introduction.md and 0.15/persistence/aggregate-store.mdx), so readers of the archived docs will repeatedly hit 404s unless the route is added or links are pointed to an existing page such as event-store.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Starlight renders the frontmatter title as h1 automatically. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The next/ version only has whats-new, so switching from any page would 404. Setting redirect: 'root' sends users to the version root instead. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy all current (v0.16) docs into next/ so that future feature documentation can be added there. Fix component import paths (4 levels), hero image path, and hero link for the next/ subdirectory. Restore next.json sidebar to include all sections. Remove redirect: 'root' from next version config since next/ now has full content. Reset next/whats-new.mdx to a placeholder. Also includes sidebar ordering fixes for application section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update ThemedImage component to accept ImageMetadata and use Astro's <Image> component instead of raw <img> tags with string paths. Import all images in MDX files and pass them as props. This fixes broken images across all versions (root, 0.15, next) and enables Astro's image optimization (webp conversion, compression). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add @components/* path alias in tsconfig.json and replace all relative component imports (../../../components/, ../../../../components/) with @components/ across all MDX files. This eliminates version-dependent import depth and simplifies copying docs between versions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
Breaking changes documented
StreamEvent.Position→StreamEvent.Revisionrenametrace-id→$traceId, removedparent-span-id)New feature docs added
StartFromoption) added to subscription docsVersioning structure
v0.16 (Stable)— current root docsv0.15— archived in0.15/directoryPreview— resetnext/to empty placeholder for future workTest plan
pnpm buildpasses (94 pages)/whats-new//0.15//infra/azure-service-bus/🤖 Generated with Claude Code