Skip to content

docs: migrate to Starlight + LikeC4, fix Storybook v10#16

Merged
jukka-matti merged 4 commits into
mainfrom
worktree-doc-methodology-upgrade
Mar 17, 2026
Merged

docs: migrate to Starlight + LikeC4, fix Storybook v10#16
jukka-matti merged 4 commits into
mainfrom
worktree-doc-methodology-upgrade

Conversation

@jukka-matti
Copy link
Copy Markdown
Owner

Summary

  • Documentation site migration: Replaced MkDocs + Structurizr with Astro Starlight + LikeC4 — adds apps/docs/ with 212 MDX pages covering vision, journeys, features, case studies, technical architecture, design system, ADRs, and product specs
  • Storybook v10 upgrade: Fixed config for Storybook 8.6+ (removed bundled @storybook/addon-essentials, explicit addon imports, new story files for all chart and UI components)
  • TypeScript strict-mode fixes: Resolved 150+ strict-mode errors across 5 packages (core, charts, hooks, ui, pwa) plus 3 additional fixes in exifStrip tests

Details

Starlight docs site (apps/docs/)

  • Full Astro + Starlight setup with sidebar navigation matching the docs/ folder structure
  • LikeC4 C4 architecture model integration (system context, containers, components)
  • TypeDoc API reference generation for @variscout/core
  • Documentation methodology (Diataxis framework + journey spine)

Storybook

  • 20+ new stories covering all chart components and key UI components
  • Config migrated to explicit addon imports (compatible with Storybook 8.6+/v10)

TypeScript

  • Fixed exifStrip test type errors
  • Resolved strict-mode errors: null checks, type assertions, missing return types

Test plan

  • pnpm build succeeds
  • pnpm test passes (~3,000 tests)
  • pnpm build-storybook succeeds
  • pnpm docs:build — verify Starlight static build
  • Visual spot-check of docs site and Storybook

🤖 Generated with Claude Code

jukka-matti and others added 3 commits March 17, 2026 18:10
Replace MkDocs (unmaintained since Aug 2024) with Astro Starlight at
apps/docs/, and Structurizr DSL (archived CLI) with LikeC4 for C4
architecture diagrams.

Starlight:
- New apps/docs/ Astro app with full sidebar config matching old nav
- Symlinks to existing docs/ — no file moves needed
- Pagefind search, Mermaid rendering via rehype-mermaid
- Workaround for zod v4 incompatibility (vite.ssr.noExternal)
- Add title frontmatter to all 218 doc files for Starlight schema
- Convert MkDocs !!! admonitions to Starlight ::: syntax (11 files)

LikeC4:
- 6 split model files at docs/architecture/likec4/ (L1-L3)
- `pnpm docs:c4` exports 8 Mermaid diagrams
- `pnpm docs:c4:serve` launches interactive C4 browser
- Delete workspace.dsl

Also includes:
- Storybook scaffolding (.storybook/)
- TypeDoc config for @variscout/core API docs
- New architecture maps (system, component, data-pipeline)
- New workflow maps (analysis-journey, investigation-lifecycle)
- Documentation methodology doc

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Resolve all merge conflicts (6 primary + 7 archive/source files):
- CLAUDE.md: take main's slim table format, add Starlight/LikeC4 entries
- data-flow.md: take main's extended frontmatter + ADR-023 See Also
- 05-technical/index.md: merge AI architecture docs + LikeC4 model entry
- 07-decisions/index.md: take main's full ADR-001–025 list
- 08-products/pwa/storage.md: accept main's deletion
- docs/index.md: main's frontmatter + Starlight footer
- promptTemplates.ts: apply main's options-object refactor
- Archive files: keep Starlight frontmatter + main's disclaimers

Post-merge fixes:
- Add title frontmatter to 19 new docs from main
- Update Starlight sidebar with ADR-014–025, AI architecture,
  methodology, new workflows, new components
- Remove deleted PWA storage and Power BI sidebar entries
- Fix remaining conflict markers in user-guide.md and architecture.md

Verified: docs:build (246 pages), docs:c4 (8 .mmd files), test (3102 pass)

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

addon-essentials and blocks are bundled into storybook core in v10 —
remove the separate packages and update manager/preview imports to use
the new storybook/* entry points. Delete orphaned ScatterPlot placeholder story.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
mean-beoynd-lite-pwa Ready Ready Preview, Comment Mar 17, 2026 5:22pm
variscout_website Ready Ready Preview, Comment Mar 17, 2026 5:22pm

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jukka-matti jukka-matti merged commit 7a368dc into main Mar 17, 2026
1 of 3 checks passed
@jukka-matti jukka-matti deleted the worktree-doc-methodology-upgrade branch March 21, 2026 11:09
jukka-matti added a commit that referenced this pull request May 14, 2026
- investigations.md "8f followups" entry: STATUS → RESOLVED 2026-05-14, PR
  #166 squash-merged as cd93691. LOW #16 (Canvas/index.tsx 1122-line
  refactor) + LOW #19 (brand ProcessHubId) explicitly carried forward.
- investigations.md gains two new entries from the --chrome walk:
  (1) pre-existing setState-in-render warning from AppMain across canvas
  transitions (App.tsx untouched by #166), (2) designer-lens canvas
  journey-clarity observations (9 UX items: Frame→Canvas rename, desktop
  LODSwitcher parity, Lock-canvas mode-toggle relabeling, L1 capability
  empty-state copy, L3 CTA visual weight, etc.).
- decision-log.md "8f canvas viewport SHIPPED" entry: Amendment 2026-05-14
  followups complete block prepended; original 2026-05-13 amendment retained
  as history.

Co-Authored-By: ruflo <ruv@ruv.net>
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