Documentation System Completion #15

New issue

Open

opened 2026-03-14 23:51:44 +00:00 by freemo · 0 comments

freemo commented

2026-03-14 23:51:44 +00:00

Owner

Background and Context

The Docusaurus documentation site was introduced in commits f9c7360b and e9fac321 (May 2025). The infrastructure works (Docusaurus config, sidebar, Kroki plugin), and 6 hand-written docs are substantive. However, 3 pages are placeholder-only, 4 event-sourcing docs are heavily self-duplicated LLM output, and the sidebar is uncurated.

Current state: Functional Docusaurus 2.4.1 site with auto-generated sidebar, custom Kroki plugin, 14 diagram blocks across 9 documents. index.md (14 lines), overview.md (19 lines), and lore.md (13 lines) are placeholders. event-sourcing-api.md is literally concatenated with itself (2194 lines, content appears twice).

Expected Behavior (End State)

A polished, complete documentation site where:

Every page contains substantive, human-authored content
No self-duplicated content exists in any document
The sidebar is curated with explicit ordering
All documentation accurately reflects the current codebase

Acceptance Criteria

index.md, overview.md, and lore.md contain substantive content
event-sourcing-api.md is de-duplicated to ~1100 lines
event-sourcing.md and immudb-integration.md are de-duplicated
event_sourcing_documentation.md is edited to remove LLM artifacts
Sidebar uses explicit ordering with curated categories
bundle exec rake documentation builds without errors

## Background and Context The Docusaurus documentation site was introduced in commits f9c7360b and e9fac321 (May 2025). The infrastructure works (Docusaurus config, sidebar, Kroki plugin), and 6 hand-written docs are substantive. However, 3 pages are placeholder-only, 4 event-sourcing docs are heavily self-duplicated LLM output, and the sidebar is uncurated. **Current state:** Functional Docusaurus 2.4.1 site with auto-generated sidebar, custom Kroki plugin, 14 diagram blocks across 9 documents. `index.md` (14 lines), `overview.md` (19 lines), and `lore.md` (13 lines) are placeholders. `event-sourcing-api.md` is literally concatenated with itself (2194 lines, content appears twice). ## Expected Behavior (End State) A polished, complete documentation site where: - Every page contains substantive, human-authored content - No self-duplicated content exists in any document - The sidebar is curated with explicit ordering - All documentation accurately reflects the current codebase ## Acceptance Criteria - [ ] `index.md`, `overview.md`, and `lore.md` contain substantive content - [ ] `event-sourcing-api.md` is de-duplicated to ~1100 lines - [ ] `event-sourcing.md` and `immudb-integration.md` are de-duplicated - [ ] `event_sourcing_documentation.md` is edited to remove LLM artifacts - [ ] Sidebar uses explicit ordering with curated categories - [ ] `bundle exec rake documentation` builds without errors