Skip to content

docs: sync README, CLAUDE.md, CONSTITUTION & docs site with current framework#271

Merged
antosubash merged 1 commit into
mainfrom
worktree-docs-sync
Jun 25, 2026
Merged

docs: sync README, CLAUDE.md, CONSTITUTION & docs site with current framework#271
antosubash merged 1 commit into
mainfrom
worktree-docs-sync

Conversation

@antosubash

Copy link
Copy Markdown
Owner

Summary

Brings the living documentation back in sync with the current framework. Audited every factual claim in the project docs against the actual origin/main source (tracked files / SimpleModule.slnx) and fixed the drift.

  • README — corrected the framework/, modules/, and packages/ lists to the real shipping set: removed non-existent demo modules (Agents/Marketplace/Orders/PageBuilder/Products/Rag), added the real Identity/Keycloak/Notifications modules, the Testing framework project, the Echo/TsConfig packages, and a tools/SimpleModule.DevTools entry. Fixed the event-bus description (Wolverine IMessageBus + convention handlers, not the non-existent IEventBus/IEventHandler<T>). Switched the module-anatomy example from the removed Products module to the real Tenants module.
  • CLAUDE.mdnpm run build:dev (not dev:build); diagnostics range SM0001-SM0061; corrected the page-registry failure description (throws a descriptive error + toast, not a silent 404).
  • CONSTITUTION & docs site — same page-registry correction; dropped vestigial TickerQ references (background jobs use a custom DatabaseJobQueue + Cronos); added the missing ConfigureAgents lifecycle row to the IModule tables; Inertia 3.x; fixed CustomerionProduction typos.

Verification

  • Factual accuracy — every changed claim independently verified against the actual code (module set, event bus, Tenants paths, SM0061 range, Cronos/DatabaseJobQueue, ConfigureAgents on IModule, Inertia ^3.0.1, page-resolver behavior in app.tsx/resolve-page.ts). Independent review pass returned zero findings.
  • Markdown integrity — balanced code fences across all 11 files; both IModule lifecycle tables column-consistent.
  • Scope — docs/markdown only (no code). Browser/QA and code build/test are not applicable; the docs-site (VitePress) build runs in CI on this PR.

Test plan

  • CI green (including the VitePress docs build)
  • Reviewer spot-checks the README module/framework lists against SimpleModule.slnx

…ramework

- README: correct framework/module/package lists to the actual shipping set —
  remove non-existent demo modules (Agents/Marketplace/Orders/PageBuilder/
  Products/Rag), add Identity/Keycloak/Notifications, the Testing project,
  Echo/TsConfig packages, and a tools/DevTools entry; fix the event-bus
  description (Wolverine IMessageBus, not IEventBus); use the real Tenants
  module as the anatomy example
- CLAUDE.md: npm script build:dev (not dev:build), diagnostics range
  SM0001-SM0061, and corrected page-registry failure behaviour (throws a
  descriptive error + toast, not a silent 404)
- CONSTITUTION & docs site: same page-registry correction; drop vestigial
  TickerQ references (jobs use a custom DatabaseJobQueue + Cronos); add the
  missing ConfigureAgents lifecycle row; Inertia 3.x; fix Customerion typos
@antosubash antosubash merged commit 0265b9b into main Jun 25, 2026
10 checks passed
@antosubash antosubash deleted the worktree-docs-sync branch June 25, 2026 14:34
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