Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
4b61f8b
docs: scaffold Astro + Starlight project replacing Docusaurus
alexeyzimarev Mar 3, 2026
2c88327
docs: add custom components and migrate all current docs content
alexeyzimarev Mar 3, 2026
616fff0
docs: add version 0.15 docs and enable starlight-versions plugin
alexeyzimarev Mar 3, 2026
60f3b58
docs: update CLAUDE.md for Astro/Starlight docs setup
alexeyzimarev Mar 3, 2026
85d084f
docs: fix plugin ordering and prometheus code block warnings
alexeyzimarev Mar 3, 2026
ca4a518
docs: fix homepage by renaming intro.mdx to index.mdx
alexeyzimarev Mar 3, 2026
3ecbe88
docs: flatten subdirectory index files to fix sidebar nesting
alexeyzimarev Mar 3, 2026
187d874
docs: replace Docusaurus dinosaur logo with Eventuous logo
alexeyzimarev Mar 3, 2026
b9a5b21
docs: group sidebar into Concepts, Building Apps, and Operations
alexeyzimarev Mar 3, 2026
954923d
docs: replace Algolia DocSearch with Starlight built-in search
alexeyzimarev Mar 3, 2026
6bd214b
docs: add hero splash homepage with feature cards
alexeyzimarev Mar 3, 2026
9e0cab9
docs: convert Docusaurus admonition syntax to Starlight format
alexeyzimarev Mar 3, 2026
3e7b02a
docs: collapse sidebar groups by default
alexeyzimarev Mar 3, 2026
a28d9b4
docs: fix ThemedImage dark mode CSS and v0.15 broken links
alexeyzimarev Mar 3, 2026
31c8666
docs: add v0.15 homepage to fix 404 on version switch
alexeyzimarev Mar 3, 2026
518639b
docs: make v0.15 the default version, preview docs under /next/
alexeyzimarev Mar 3, 2026
861626c
docs: shorten version label to 'v0.15' to fit selector
alexeyzimarev Mar 3, 2026
795361d
docs: widen version selector to fit 'v0.15 (Stable)' label
alexeyzimarev Mar 3, 2026
2b9dcd8
docs: set accent color to match Eventuous logo blue
alexeyzimarev Mar 3, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ samples/ Sample apps (esdb, postgres, kurrentdb, banking)

## Documentation Site

The `docs/` directory is a Docusaurus v3 site (https://eventuous.dev). Requires Node >=18.19.0 and pnpm.
The `docs/` directory is an Astro + Starlight site (https://eventuous.dev). Requires Node >=20.0.0 and pnpm.

```bash
cd docs
Expand All @@ -106,19 +106,16 @@ cd docs
pnpm install

# Local dev server with hot reload
pnpm start
pnpm dev

# Production build (output to docs/build/)
# Production build (output to docs/dist/)
pnpm build

# Serve the production build locally
pnpm serve

# TypeScript validation
pnpm typecheck
pnpm preview
```

Docs content lives in `docs/docs/` as `.md` and `.mdx` files organized by topic: `domain/`, `persistence/`, `application/`, `subscriptions/`, `read-models/`, `producers/`, `gateway/`, `diagnostics/`, and `infra/` (per-provider: esdb, postgres, mongodb, mssql, kafka, rabbitmq, pubsub, elastic). MDX files can embed React components. Mermaid diagrams are supported in markdown code blocks. Versioned docs are in `versioned_docs/` (current version: 0.15). The build enforces no broken links.
Docs content lives in `docs/src/content/docs/` as `.md` and `.mdx` files organized by topic: `domain/`, `persistence/`, `application/`, `subscriptions/`, `read-models/`, `producers/`, `gateway/`, `diagnostics/`, and `infra/` (per-provider: esdb, postgres, mongodb, mssql, sqlite, kafka, rabbitmq, pubsub, elastic). MDX files can use Astro components. Mermaid diagrams are supported via `starlight-client-mermaid` plugin. Versioned docs (0.15) are managed by the `starlight-versions` plugin in `docs/src/content/docs/0.15/`. Sidebar is configured in `astro.config.mjs`. Frontmatter uses Starlight format (`sidebar.order` for ordering, not `sidebar_position`).

## Code Style

Expand Down
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
dist/
.astro/
41 changes: 0 additions & 41 deletions docs/README.md

This file was deleted.

70 changes: 70 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import starlightVersions from 'starlight-versions';
import starlightMermaid from '@pasqal-io/starlight-client-mermaid';

export default defineConfig({
site: 'https://eventuous.dev',
integrations: [
Comment on lines +6 to +8

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

2. Docs base path unclear 🐞 Bug ✓ Correctness

The Astro config does not set a base path, implying root deployment, but the repo still contains
/docs-prefixed URLs/redirects and at least one prominent hard-coded root link. Depending on where
the site is actually hosted, this will either break existing inbound links (/docs/...) or break site
assets/navigation when deployed under /docs.
Agent Prompt
### Issue description
Docs routing appears inconsistent: Astro config implies root deployment, but the codebase still references /docs URLs and includes /docs redirects. This can break navigation/assets depending on hosting.

### Issue Context
- If hosted at `https://eventuous.dev/docs/...`, Astro should be configured with a `base` and content should avoid hard-coded root links.
- If hosted at `https://eventuous.dev/...`, then existing /docs references (READMEs, redirects) should be updated/redirected.

### Fix Focus Areas
- docs/astro.config.mjs[6-69]
- docs/src/content/docs/index.mdx[9-13]
- docs/public/_redirects[1-9]
- src/Kafka/src/Eventuous.Kafka/README.md[1-5]

### Suggested direction
Option A (host under /docs):
- Add `base: '/docs'` in `defineConfig({ ... })`.
- Update homepage hero action link to be base-aware (avoid `link: '/intro/'`; use a relative internal link if supported, e.g. `link: 'intro'`).
- Update `head` favicon href to be base-aware (avoid `href: '/favicon.ico'` if deployed under /docs).

Option B (host at root):
- Update repo references like `https://eventuous.dev/docs/...` to `https://eventuous.dev/...`.
- Consider adding redirects from `/docs/*` -> `/*` to preserve existing inbound links.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

starlight({
title: 'Eventuous',
logo: {
src: './src/assets/logo.png',
},
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/eventuous/eventuous' },
{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/ZrqM6vnnmf' },
],
customCss: ['./src/styles/custom.css'],
plugins: [
starlightVersions({
current: { label: 'v0.15 (Stable)' },
versions: [{ slug: 'next', label: 'Preview' }],
}),
starlightMermaid(),
],
sidebar: [
{ label: 'Introduction', slug: 'intro' },
{ label: "What's New", slug: 'whats-new' },
{
label: 'Concepts',
collapsed: true,
items: [
{ label: 'Prologue', autogenerate: { directory: 'prologue' } },
{ label: 'Domain', autogenerate: { directory: 'domain' } },
{ label: 'Persistence', autogenerate: { directory: 'persistence' } },
],
},
{
label: 'Building Apps',
collapsed: true,
items: [
{ label: 'Application', autogenerate: { directory: 'application' } },
{ label: 'Subscriptions', autogenerate: { directory: 'subscriptions' } },
{ label: 'Read Models', autogenerate: { directory: 'read-models' } },
{ label: 'Producers', autogenerate: { directory: 'producers' } },
{ label: 'Gateway', autogenerate: { directory: 'gateway' } },
],
},
{
label: 'Operations',
collapsed: true,
items: [
{ label: 'Diagnostics', autogenerate: { directory: 'diagnostics' } },
{ label: 'Infrastructure', autogenerate: { directory: 'infra' } },
{ label: 'FAQ', autogenerate: { directory: 'faq' } },
],
},
],
head: [
{
tag: 'link',
attrs: { rel: 'icon', href: '/favicon.ico', sizes: '32x32' },
},
],
editLink: {
baseUrl: 'https://github.com/eventuous/eventuous/edit/dev/docs/',
},
}),
],
});
3 changes: 0 additions & 3 deletions docs/babel.config.js

This file was deleted.

230 changes: 0 additions & 230 deletions docs/docs/application/command-api.md

This file was deleted.

Loading