docs: scaffold VitePress site with detailed guides - #57
Merged
Conversation
Add a VitePress-powered documentation site under docs/ organized into guide / framework / database / frontend / testing / reference sections. Covers installation, module authoring end-to-end, discovery and lifecycle hooks, middleware pipeline ordering, SQLModel conventions, per-module Base and mixins, session commit semantics, migrations, Inertia page discovery and shared props, i18n, permissions, events, pytest fixtures, make targets, env vars, diagnostic codes, and deployment. Links through to the pre-existing authoritative single-page docs (framework-conventions, module-authoring, e2e-testing, release). Excludes plans/ superpowers/ release-notes/ from the VitePress build (pre-existing design docs contain unescaped angle brackets that vue-sfc chokes on). .gitignore covers .vitepress/cache and .vitepress/dist. https://claude.ai/code/session_01HFcdxte9HSQpdG8BeNXAp6
antosubash
marked this pull request as ready for review
April 29, 2026 10:45
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a VitePress-powered documentation site under
docs/. VitePress is Vite-based and pure-markdown, so the source stays readable in the repo but the rendered site gets search, sidebar navigation, dark mode, and code highlighting for free.Structure
The pre-existing authoritative single-page docs (
framework-conventions.md,module-authoring.md,e2e-testing.md,release.md) are preserved and linked from the sidebars — they remain the source of truth when conventions are ambiguous.Contents covered
app.state.smServices container, three settings surfaces (env / module-env / DB-backed), permissions, event bus, i18n.Base,AuditMixin/SoftDeleteMixin/MultiTenantMixin/VersionedMixin,get_dbcommit-on-writes semantics, Alembic workflow + branch labels."Orders/Browse"→modules/orders/orders/pages/Browse.tsx), shared-props contract, CSRF viaSameSite=Lax.conftest.py, auth'd vs anonymous clients, parametrization patterns.maketargets, everySM_*env var, everySM0XXdiagnostic code with fixes, production deploy checklist.Build
Verified:
npm run buildsucceeds locally.plans/,superpowers/, andrelease-notes/are excluded from the VitePress build viasrcExclude(pre-existing design docs contain unescaped<...>that vue-sfc chokes on).Test plan
npm run buildcompletes without errorsscripts/check_file_size.pypasses (config.ts is under the 300-line cap)npm run devand click through every sidebar entry to confirm nothing 404shttps://claude.ai/code/session_01HFcdxte9HSQpdG8BeNXAp6
Generated by Claude Code