docs(#4886): label deprecated features in user documentation#5462
docs(#4886): label deprecated features in user documentation#5462fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add visible deprecation notices to user-facing documentation for deprecated features, establish a contributor convention for deprecation labeling, and document a versioning investigation. Changes: - Add deprecation notice convention to CONTRIBUTING.md with blockquote, inline, and index entry templates - Label `runner_env` as deprecated in bring-your-own-agent.md with migration guidance to `env.runner` (ADR 0055) - Update per-org mode notice from "Planned deprecation" to "Deprecated" with migration guidance (ADR 0044) - Convert inline deprecation annotations to blockquote notices in customizing-agents.md for `customized/skills/` and `customized/agents/` sections (ADR 0064) - Add ADR link to `admin install` deprecation in cli-internals.md - Add ADR link to `customized/` deprecation reference in customizing-with-agents-md.md - Mark org-mode as deprecated in guides/README.md index - Add documentation versioning investigation to doc-site.md evaluating four approaches with recommendation Note: pre-commit could not run (network restriction in sandbox). The post-script runs an authoritative pre-commit check. Closes #4886
|
🤖 Finished Review · ✅ Success · Started 1:45 PM UTC · Completed 2:01 PM UTC |
Site previewPreview: https://7da21084-site.fullsend-ai.workers.dev Commit: |
ReviewFindingsMedium
Low
Labels: PR is documentation-only work establishing deprecation conventions and labeling deprecated features across user-facing guides |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
| The typical handoff: a GCP admin runs `mint deploy`, `mint enroll`, and `inference provision`, then passes the mint URL and WIF provider resource name to a GitHub maintainer who runs `github setup --mint-url=... --inference-wif-provider=...`. See [Advanced setup](../infrastructure/advanced-setup.md). | ||
|
|
||
| > **Note:** The legacy `admin install` command wraps all phases into a single invocation but is deprecated. The standalone commands above are the recommended path. See the [Unified Installation Flow](#unified-installation-flow) section below for how the phases are structured internally. | ||
| > **Deprecated:** The `admin install` command is deprecated per |
There was a problem hiding this comment.
[medium] documentation-accuracy
The deprecation notice attributes the admin install deprecation to ADR-0069 ('Ready-made configuration presets'), but ADR-0069 does not make the deprecation decision — it merely mentions the deprecation as pre-existing context. The actual deprecation of per-org commands including admin install is decided in ADR-0044 ('Deprecate per-org installation mode'). Readers following the ADR-0069 link will find a decision about config presets, not about admin install deprecation.
Suggested fix: Change the ADR reference to ADR-0044, or omit the ADR reference and state the deprecation without attribution.
| > New installations should use the [per-repo Getting Started guides](README.md). | ||
| > Existing per-org installations continue to work and are fully supported during | ||
| > the transition. To migrate, run `fullsend github setup` per-repo instead of | ||
| > `fullsend admin install` per-org. |
There was a problem hiding this comment.
[low] migration-guidance
The migration guidance says 'run fullsend github setup per-repo instead of fullsend admin install per-org.' ADR-0044 Section 3 prescribes a more detailed migration process using fullsend admin install / with specific flags or fullsend admin migrate . The simplified guidance risks users missing critical migration steps.
Suggested fix: Link to the full migration plan in ADR-0044 Section 3, or mention fullsend admin migrate.
fullsend-ai-review
Bot
added
requires-manual-review
1 participant
Summary
Add visible deprecation notices and migration guidance to user-facing documentation for deprecated features (
runner_env,customized/overlay, per-org mode,admin install), establish a contributor convention for deprecation labeling, and document a documentation versioning feasibility investigation.Related Issue
Closes #4886
Changes
runner_envlabeling (bring-your-own-agent.md): Add deprecation notice with migration guidance toenv.runnerper ADR-0055; mark in field reference table and code examplescustomized/overlay (customizing-agents.md): Convert inline deprecation annotations to proper blockquote notices linking ADR-0064 forcustomized/skills/andcustomized/agents/sectionsadmin install(cli-internals.md): Add ADR-0069 link and use consistent deprecation formatTesting
lycheemarkdown link checker passes on all changed files (0 errors)scan-secretspasses on all changed filesgitlintpasses on commit messageChecklist
!for breaking changes)Closes #4886
Post-script verification
agent/4886-label-deprecated-docs)cb2bcd9f282952232249eca4a281a3392a617d41..HEAD)