docs: full review and sync of docs to current code state - #205
Merged
Conversation
Comprehensive pass over all documentation to match the current framework: single shared schema (schema-per-module removed), pluggable auth providers (Keycloak OIDC + Microsoft/Entra OAuth), method-aware public routes, principal-resolver chain, and diagnostics through SM021. - VitePress sidebar/nav: add Principal resolvers + Public routes (framework) and keycloak + audit_log (modules) pages - New module pages: docs/modules/audit_log.md, docs/modules/keycloak.md - index.md / overview: "ten first-party modules"; de-count lifecycle hooks - README: per-module list drops "schema"; pluggable-auth wording; framework layout adds cli/ + testing/; single-shared-schema isolation - CLAUDE.md: Vite port 5050; kill ports; pytest "-m not e2e and not perf" - .env.example + CLI docs: "uv run smpy ..." console-script form - deployment: run alembic from host/ for default workspace scaffold - pages.md: fix SectionTitle usage (children, not title prop) - registries skill: drop nonexistent HasPermission/@require_permission - first-module: real PageShell + Table subpath imports - sync all framework/database/frontend/testing/reference single-pagers, module + package READMEs, and skills
Deploying simple-module-python with |
| Latest commit: | 85694d0 |
| Status: | ✅ Deploy successful! |
| Preview URL: | https://92990a3f.simple-module-python.pages.dev |
| Branch Preview URL: | https://worktree-docs-sync.simple-module-python.pages.dev |
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Jun 8, 2026
This was referenced Jun 8, 2026
2 tasks
antosubash added a commit
that referenced
this pull request
Jun 25, 2026
…t caching (#221) Bring the published docs current with features landed after the #205 sync: - modules/branding.md (new): admin-configurable app name/logo/favicon/colour, endpoints, permissions, image guard-rails, shared-props data flow; add to the modules index (ten→eleven) and the VitePress sidebar. - modules/users.md: admin user CRUD (create/edit/delete) endpoints + pages + events; external/SSO users (is_external, nullable password, credential guards); bearer-token endpoints; corrected stale admin HTTP methods, edit view-route path, contracts import path, and component file names. - modules/dashboard.md: /dashboard/doctor route, Doctor admin menu item, page. - reference/deployment.md: production manifest-based Inertia rendering + ImmutableStaticFiles 1-year cache headers. reference/env-vars.md: SM_VITE_PORT. Claude-Session: https://claude.ai/code/session_01QzhhE5RjEPdeP4eSKjxzLF
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Comprehensive review of all documentation in the repo, synced to the current state of the framework. The docs had drifted from several recent changes; this pass brings every page, README, and skill into agreement with the code.
Major code realities now reflected in the docs:
__tablename__. Removed all "schema isolation" framing.AuthProvidercontract, principal-resolver chain (session or bearer), method-awareregister_public_routes, the Keycloak OIDC module, and Microsoft/Entra OAuth inusers. New diagnostics SM020 (multiple auth providers = error) / SM021 (none = warn).smpy/simple-moduleconsole-script form used throughout (uv run smpy users create-admin,smpy host gen-pages, …).smpy new= workspace mode — app underhost/,alembic.iniathost/alembic.ini; deployment docs run migrations fromhost/.What changed
config.ts): added Principal resolvers + Public routes (framework) and keycloak + audit_log (modules).docs/modules/audit_log.md,docs/modules/keycloak.md.cli/+testing/; Vite port5050; pytest markernot e2e and not perf; console-script commands.pages.mdSectionTitleusage (children, not atitleprop);first-module.mdrewritten to realPageShell+Tablesubpath imports; registries skill drops the nonexistentHasPermission/@require_permissionAPIs (onlyRequiresPermissionexists); deployment runsalembicfromhost/.Notes / verification
.envURL vs. the scaffold compose credentials) — the real fix belongs in the scaffold templates, out of scope for a docs sync.