docs: document the compose personas, --compose-extensions, and the publish gate#201
Merged
Conversation
…blish gate ai-autopilot README named a nonexistent universalOrmModeler persona and called the default stack Vike + universal-orm; the built-in is dataModeler (Prisma) and the canonical default is Vike + Prisma. Fix both, and document the opt-in vikeExtensionPersonas composer set. framework README omitted --compose-extensions and never explained the composer path or the publish gate; add the flag and a short section. Also refresh the --help text, which described the flag as vike-auth only. Closes #200
suleimansh
added
documentation
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
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.
Pass-4 docs alignment: the compose-personas work shipped but the docs never caught up. Docs-only; framework tests green (57).
Fixed drift
universalOrmModelerand called the default stack "Vike + universal-orm". The built-in data persona isdataModeler(Prisma) and the code's canonical default is "Vike + Prisma" (steps.ts,index.ts,library.ts). Corrected both, and added a short "Composing vike-* extensions (opt-in)" subsection documenting thevikeExtensionPersonasset (auth, data, rbac, crud, themes/layouts + the neutral guardrail) and the publish gate.--compose-extensionsto the CLI list and a "Composing vike-* extensions" section explaining the composer path and why it is opt-in (publish-safe default).--helptext described the flag as "vike-auth for auth" only; it now names the full set. Patch changeset since it changes user-facing--helpoutput.Out of scope (flagged, not fixed here)
"Vike + universal-orm" also appears across the 7 shipped prompt bodies (
prompts/*.md) and test fixtures, while the code default is Prisma. That is a separate, agent-facing inconsistency (the prompt bodies steer the reviewer's assumed stack) that predates this work and needs a product call on whether the default is Prisma or universal-orm. Happy to take it as a follow-up.Closes #200