QVAC-24016 doc: document qvac configure command - #4005
Open
BrunoCampana wants to merge 1 commit into
Open
Conversation
- Add a `qvac configure` reference entry under /cli mirroring the
wording in packages/cli/README.md, so the feature author (likely
reviewer) recognizes the text. Only addition vs README: a cross-link
to /cli/http-server#configuration for the shape of `serve.models`.
- Promote `qvac configure` as the recommended path on the HTTP server
"Running the server" Step 2. Keep manual JSON authoring as a
"Prefer to write it by hand?" Callout naming the cases the command
doesn't cover: .js/.ts configs, and keys beyond `serve.models`
(plugins, cacheDirectory, serve.cors, etc.).
- On /cli Usage Step 2, keep manual authoring as the primary
instruction and add a deliberately vague Tip ("help with part of
the configuration"), because /cli covers more than `serve.models`.
- Add an inline Tip under /configuration `#### ModelEntry` so readers
reaching the schema also find the command.
- Not touched: sidebar (custom-tree.ts) — the command is a subsection
of /cli, not a top-level entry; addon pages — docs-links from the
command already target existing addon pages.
Contributor
Review StatusCurrent Status: ❌ PENDING Pending reviews: Needs 1 Management or Team Lead, and 1 more from Management, Team Lead, or Member. |
Contributor
License compliance — cleanNo new dependency license findings in this PR. Warn-only (shadow) mode — this check does not block merges yet. Updated automatically by the canonical license compliance workflow. NOTICE presence (advisory)Missing NOTICE (advisory, does not block):
|
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.
What problem does this PR solve?
#3953 shipped a new CLI subcommand,
qvac configure. It needs to be documented on the website.How does it solve it?
Updated pages:
/cli— new### qvac configurereference entry (mirrors the wording of the### configuresection inpackages/cli/README.mdso review is straightforward)./cli/http-server— Step 2 of "Running the server" now leads withqvac configure; manual JSON authoring kept as a fallback Callout./configuration— cross-reference to the command under#### ModelEntry.