docs(#4886): label deprecated features in user documentation - #5462
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://b729479a-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 |
|
/fs-fix remove mentions to ADRs, just that something is deprecated and the alternative. |
|
🤖 Finished Fix · ✅ Success · Started 7:23 AM UTC · Completed 7:27 AM UTC |
Simplify deprecation notices to state only what is deprecated and what the alternative is, without referencing specific ADR numbers. Addresses review feedback on #5462
🔧 Fix agent — iteration 1 (human-triggered)Removed all ADR references from deprecation notices across 7 files per human instruction. Each notice now states only what is deprecated and what the alternative is. Fixed (7):
Tests: passed Updated by fullsend fix agent |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
🤖 Finished Retro · ✅ Success · Started 7:52 AM UTC · Completed 8:03 AM UTC |
Retro: PR #5462 — Label deprecated features in user documentationWorkflow timeline:
Assessment: The pipeline worked well overall. The code agent completed the initial task efficiently (10 min, 8 files). The review agent correctly identified a real accuracy problem (wrong ADR attribution). The fix agent executed the human's broader correction cleanly in a single iteration. Total agent compute was proportionate to the task. Rework analysis: One fix iteration was needed. The root cause was the code agent citing ADR numbers in user-facing deprecation notices — it got one citation wrong (ADR-0069 instead of ADR-0044), and more broadly, the human decided that ADR references don't belong in user-facing docs at all. The review agent caught the specific error but not the higher-level pattern. The human added the insight that users don't need internal decision-record numbers. Existing issues cover the improvement opportunities:
No new proposals filed — the identified improvements are already tracked in the issues above. |
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)