Skip to content

docs: surface uninstall guidance and complete SRE profile overview #2652

Closed

Description

@codeforester

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 grpcurl to the technical overview's SRE profile list to match the shipped manifest/registry.
  • Add a concise basectl uninstall entry/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

Validation

  • Compare the SRE row with the shipped manifest and artifact registry.
  • Validate documentation links and run git diff --check.

Non-Goals

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.

Activity

  1. self-assigned this
    on Nov 5, 2026
  2. moved this to Backlog in baseon Nov 5, 2026
  3. added this to the v1.11.0 milestone on Nov 5, 2026
  4. moved this from Backlog to Ready in baseon Nov 5, 2026
  5. moved this from Ready to In Progress in baseon Nov 5, 2026
  6. moved this from In Progress to In Review in baseon Nov 6, 2026
  7. moved this from In Review to Done in baseon Nov 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

No type

Projects

  • Status
    Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions