Repository navigation
Description
Goal
Make Base's user-facing front doors point to uninstall guidance and make the technical overview's SRE profile match the shipped package selection.
Background
The command reference already lists basectl uninstall, and the shipped SRE profile includes grpcurl; the technical overview's SRE package row omits grpcurl and its selected command tables omit uninstall. README and FAQ also do not currently point users to uninstall guidance. PR #2629 is adding the canonical uninstall guide, so README/FAQ links should land after that guide is available. Audit evidence and the dependency are tracked in #2650 and #2629.
Scope
- Add
grpcurlto the technical overview's SRE profile list to match the shipped manifest/registry. - Add a concise
basectl uninstallentry/link in the technical overview. - Add user-facing README and FAQ links to the canonical uninstall guide introduced by docs: reconcile audited design and implementation drift #2629, after its path is confirmed.
- Keep detailed uninstall semantics in the canonical guide and preserve the approved behavior: project run bundles are removed while Base-level run history is retained.
Acceptance Criteria
- The overview's SRE list matches the shipped SRE profile.
- The technical overview, README, and FAQ make uninstall guidance discoverable without duplicating the guide.
- Links target the canonical guide from docs: reconcile audited design and implementation drift #2629 and resolve on the target branch.
- The wording matches the approved retention behavior and does not claim that uninstall leaves no residue.
- The docs: audit remaining design and command contract gaps #2650 crosswalk records the fix and dependency.
Validation
- Compare the SRE row with the shipped manifest and artifact registry.
- Validate documentation links and run
git diff --check.
Non-Goals
- Change uninstall behavior or broaden the uninstall guide scope.
- FAQ heading capitalization cleanup.
- Change other technical-overview testing or CI documentation; see ci: remove obsolete Base-local lib/python paths #2649 for the separate
lib/pythonpath follow-up.
Project Fields
- Priority: P2
- Size: S
- Area: Docs
- Initiative: Contract Hardening
Agent Assignment
The assigned maintainer should wait for #2629's canonical guide path, make this narrow discoverability correction, and link the PR to this issue and audit #2650.
Metadata
Metadata
Assignees
Labels
Type
Projects
- StatusShow more project fieldsDone
Activity
docs: audit remaining design and command contract gaps (#2655)