docs: document the advisor command and repository scoping#809
Draft
benw5483 wants to merge 1 commit into
Draft
Conversation
Add user documentation for `actual advisor` and its `--repo` repository scoping to the README and Getting Started guide, and record the advisor command and repo scoping in the changelog. - README gains an "Ask the Advisor" section and lists `actual advisor` in the command reference. - Getting Started gains an "Ask the Advisor" section with a full flag reference and a scoping guide: git-remote auto-detection, the sticky per-repository scope, `--repo none`/`--repo auto`, and `--show-scope`. - CHANGELOG records the advisor command and repository scoping under a new Unreleased section. Documentation only; no code changes. Generated by the operator's software factory. City: factory-main · Agent: local-core.builder-2 On behalf of: @benw5483 Co-Authored-By: <operator-factory-bot> <factory-bot@<operator-domain>.invalid>
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.
Summary
actual advisorcommand in the README and Getting Started guide (a new "Ask the Advisor" section in each, andactual advisoradded to the command reference).--reporepository scoping: scope by name /owner/name/ UUID, git-remote auto-detection, an organization-level fallback, the scope remembered per repository, thenoneandautokeywords, and--show-scope.[Unreleased]entry recording the advisor command and repository scoping (shipped after 0.1.4 but not previously changelogged), plus the new documentation.The advisor command and its scoping already exist in the CLI; this PR only documents them. The docs mirror the command's
--helptext and current behavior onmain(the start-and-poll answer flow). No code changes.Test plan
actual advisor --helpmatches the flag reference indocs/GETTING_STARTED.md.