docs: deprecate all-in-one admin, restructure reference/ into sidebar sections - #2698
Conversation
PR Summary by QodoDocs: deprecate all-in-one admin install; move reference docs into admin guides Description
Diagram
High-Level Assessment
Files changed (12)
|
Site previewPreview: https://f0d85dd2-site.fullsend-ai.workers.dev Commit: |
|
🤖 Review · |
Code Review by Qodo
1. operations.md lacks prerequisites section
|
8cee294 to
cc80ad3
Compare
|
🤖 Finished Review · ✅ Success · Started 3:40 PM UTC · Completed 3:51 PM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsHigh
Medium
Previous runReviewFindingsHigh
Medium
Previous runReviewFindingsHigh
Medium
Previous run (2)ReviewFindingsHigh
Medium
Previous run (3)ReviewFindingsHigh
Medium
Previous run (4)ReviewFindingsMedium
Previous run (5)ReviewFindingsMedium
Previous runReviewFindingsMedium
Labels: PR restructures documentation under docs/guides/ and removes docs/reference/ Previous run (6)ReviewFindingsMedium
Previous run (7)ReviewFindingsMedium
Labels: PR restructures documentation under docs/guides/ and removes docs/reference/ |
cc80ad3 to
9ea0cf4
Compare
|
🤖 Review · |
9ea0cf4 to
0ddeec3
Compare
|
🤖 Review · |
0ddeec3 to
69d49bb
Compare
|
🤖 Finished Review · ✅ Success · Started 4:18 PM UTC · Completed 4:32 PM UTC |
69d49bb to
a5e20be
Compare
55df00a to
a8eb42c
Compare
|
🤖 Review · |
249ca9f to
e38f829
Compare
e38f829 to
8303b5e
Compare
|
🤖 Review · |
8303b5e to
dc756db
Compare
|
🤖 Review · |
… sections Replace docs/reference/ (installation.md, github-setup.md) with two focused guides placed in their respective sidebar sections: - docs/guides/infrastructure/advanced-setup.md — deployment models (managed vs self-hosted), setup flags, custom app sets, manual WIF - docs/guides/getting-started/operations.md — enrollment, config updates, status, uninstall, standalone commands, IAM matrix Add planned-deprecation note to org-mode.md referencing ADR 0044. Update VitePress sidebar config and all cross-references (13 files). Assisted-by: Claude Signed-off-by: Wayne Sun <gsun@redhat.com>
dc756db to
69ebef9
Compare
|
🤖 Finished Review · ✅ Success · Started 7:44 PM UTC · Completed 7:59 PM UTC |
|
|
||
| If the platform operator also provides a pre-existing WIF provider, skip `inference provision` and pass `--inference-wif-provider` directly to `github setup`. | ||
|
|
||
| If you have IAM access to the platform operator's GCP project, pass `--mint-project` and `--mint-region` to `github setup` to enable auto-discovery of shared app IDs and automatic validation of mint configuration. This requires `roles/cloudfunctions.developer` on the platform mint project. |
There was a problem hiding this comment.
[high] api-contract
--mint-project and --mint-region are documented as flags for fullsend github setup, but github setup (in internal/cli/github.go) does not define these flags. They exist only on the deprecated fullsend admin install command.
Suggested fix: Either remove the sentence about --mint-project/--mint-region on github setup, or add these flags to newGitHubSetupCmd() in internal/cli/github.go.
| # 3. Provision inference WIF | ||
| fullsend inference provision "$FIRST_ORG" --project="$GCP_PROJECT" | ||
|
|
||
| # 4. Configure GitHub with public apps (installable by other orgs) |
There was a problem hiding this comment.
[high] api-contract
The multi-org First org example uses non-existent CLI flags: fullsend mint status -o url and fullsend inference status -o provider. mint status has no -o flag; inference status uses --format with values text, json, env.
Suggested fix: Replace the inline subshells with placeholder variables and add comments explaining how to obtain values from prior commands output.
|
|
||
| **Additional orgs (install existing public apps):** | ||
| **Additional orgs (enroll in existing mint + install existing public apps):** | ||
|
|
There was a problem hiding this comment.
[medium] logic-error
In the Additional orgs example, $MINT_URL and $WIF_PROVIDER are referenced but never assigned due to the invalid subshell commands in the First org section.
Suggested fix: Add explicit variable assignments with instructions to copy values from prior command output.
| | `ResolveExplicit` | Validate linux/{arch} ELF for `--fullsend-binary` | | ||
|
|
||
| Vendoring commit messages use title + body (upload and stale delete). `admin analyze` reports stale vendored assets at `bin/fullsend` or `.fullsend/bin/fullsend` without install-intent flags. | ||
| Vendoring commit messages use title + body (upload and stale delete). `github status` reports stale vendored assets at `bin/fullsend` or `.fullsend/bin/fullsend` without install-intent flags. |
There was a problem hiding this comment.
[medium] logic-error
Changed from admin analyze reports stale vendored assets to github status reports stale vendored assets, but github status does not check for stale vendored assets. That functionality remains in admin analyze.
Suggested fix: Revert to admin analyze reports stale vendored assets or note that this functionality is not yet available in a non-deprecated command.
|
🤖 Finished Retro · ✅ Success · Started 8:06 PM UTC · Completed 8:15 PM UTC |
Retro: PR #2698 — docs: deprecate all-in-one admin, restructure reference/Timeline
AssessmentReview quality was strong. The review bot correctly identified that the docs claimed CLI flags ( The findings were never addressed. The PR was merged with incorrect CLI flag documentation. The human LGTM approval came just 3 minutes after the bot's first CHANGES_REQUESTED, suggesting the bot's findings may not have been read. Review noise was significant. The bot posted 11 inline comments across 3 review rounds, but only ~4 were unique findings — each was repeated 3 times on the same commit SHA. Existing issues covering observed patternsAll major improvement opportunities from this workflow are already tracked:
No new proposals are warranted — the existing issue backlog comprehensively covers the improvement opportunities identified in this workflow. |
Summary
Deprecates the all-in-one
fullsend admincommand tree in user-facing docs, eliminatesdocs/reference/, and creates properly scoped documentation in the correct sidebar sections.docs/guides/getting-started/operations.md— per-repo day-2 administration: config updates, workflow syncing, uninstall, standalone commands table, IAM matrix, status notifications. Placed in the Getting Started sidebar since it targets repo maintainers.docs/guides/infrastructure/advanced-setup.md— non-standard installation paths: managed-mode variants (platform-provided infra, reusing existing infra, per-repo flags), self-hosted mint deployment, custom app sets, manual WIF, OAuth scopes. Placed in the Infrastructure sidebar since self-hosted content targets platform operators.docs/guides/getting-started/org-mode.md— expanded with per-org day-2 operations (enrollment, sync-scaffold, github status, org uninstall) and planned deprecation note per ADR 0044admin install/uninstall/analyze/enable/disablereferences replaced with standalone equivalents (github setup,github enroll/unenroll,github status,github uninstall,inference provision/deprovision)docs/reference/directory deleted (3 files) — content split between new files and existing getting-started guidesmint deploy) and GitHub App creation are independent — no "first org bootstraps everything" modelWhat changed
docs/reference/installation.mdgetting-started/operations.md+infrastructure/advanced-setup.mddocs/reference/github-setup.mdgetting-started/operations.md+infrastructure/advanced-setup.mddocs/reference/README.mdFiles updated (cross-references)
docs/cli/github.md,docs/cli/inference.md,docs/cli/mint.md,docs/guides/getting-started/configuring-github.md,docs/guides/getting-started/org-mode.md,docs/guides/infrastructure/mint-administration.md,docs/guides/infrastructure/infrastructure-reference.md,docs/guides/user/running-agents-locally.md,docs/guides/dev/cli-internals.md,docs/guides/README.md,docs/ADRs/0047-vendored-installs-with-vendor-flag.md,website/.vitepress/config.tsTest plan
hack/lint-docs-linkspasses (0 broken links)reference/installationorreference/github-setuppaths in docs/github status, enrollment)