Skip to content

docs(#4886): label deprecated features in user documentation - #5462

Merged
rh-hemartin merged 2 commits into
mainfrom
agent/4886-label-deprecated-docs
Jul 27, 2026
Merged

docs(#4886): label deprecated features in user documentation#5462
rh-hemartin merged 2 commits into
mainfrom
agent/4886-label-deprecated-docs

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

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

  • Deprecation convention (CONTRIBUTING.md): Add a "Deprecation notices in documentation" section with three templates (blockquote, inline, index entry) and guidance on what to include and when to add notices
  • runner_env labeling (bring-your-own-agent.md): Add deprecation notice with migration guidance to env.runner per ADR-0055; mark in field reference table and code examples
  • Per-org mode (org-mode.md): Update "Planned deprecation" to "Deprecated" with migration command per ADR-0044; mark in guides/README.md index
  • customized/ overlay (customizing-agents.md): Convert inline deprecation annotations to proper blockquote notices linking ADR-0064 for customized/skills/ and customized/agents/ sections
  • admin install (cli-internals.md): Add ADR-0069 link and use consistent deprecation format
  • ADR link (customizing-with-agents-md.md): Add missing hyperlink to ADR-0064
  • Versioning investigation (doc-site.md): Evaluate four approaches (VitePress multi-version, branch-based, git tag snapshots, deprecation-only) with recommendation to revisit when features are removed

Testing

  • lychee markdown link checker passes on all changed files (0 errors)
  • scan-secrets passes on all changed files
  • gitlint passes on commit message
  • No Go code changed — docs-only PR

Checklist

  • PR title follows Conventional Commits (correct type, ! for breaking changes)
  • Commits are signed off (DCO) — human and human-directed agent sessions only
  • I wrote this contribution myself and can explain all changes in it

Closes #4886

Post-script verification

  • Branch is not main/master (agent/4886-label-deprecated-docs)
  • Secret scan passed (gitleaks — cb2bcd9f282952232249eca4a281a3392a617d41..HEAD)
  • PR body secret scan passed (gitleaks — no-git)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

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
@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner July 22, 2026 13:43
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Jul 22, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Jul 22, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 1:45 PM UTC · Completed 2:01 PM UTC
Commit: 3db5677 · View workflow run →

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown

Site preview

Preview: https://b729479a-site.fullsend-ai.workers.dev

Commit: 6d7ec235e7933ac906b5c4221e237957ff070ea7

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [documentation-accuracy] docs/guides/dev/cli-internals.md:185 — The deprecation notice attributes the admin install deprecation to ADR-0069 ("Ready-made configuration presets for simplified installation"), but ADR-0069 does not make the deprecation decision — it merely mentions the deprecation as pre-existing context in its Context section. The actual deprecation of per-org commands including admin install <org> is decided in ADR-0044 ("Deprecate per-org installation mode"). Readers following the ADR-0069 link will find a decision about config presets and layered configuration, not about admin install deprecation.
    Remediation: Change the ADR reference to ADR-0044, or omit the ADR reference and state the deprecation without attribution.

Low

  • [migration-guidance] docs/guides/getting-started/org-mode.md:12 — The new migration guidance says "run fullsend github setup per-repo instead of fullsend admin install per-org." However, ADR-0044 Section 3 prescribes a more detailed migration process using fullsend admin install <owner>/<repo> with specific flags or fullsend admin migrate <org> <repo>. The simplified guidance risks users missing critical migration steps.
    Remediation: Link to the full migration plan in ADR-0044 Section 3, or mention fullsend admin migrate which is the purpose-built migration command.

  • [stale-doc] docs/architecture.md — The "Configuration layering" section describes the customized/ overlay mechanism. It mentions deprecation inline but not in the blockquote format established by this PR's new CONTRIBUTING.md convention.
    Remediation: Add a blockquote deprecation notice referencing ADR-0064 to match the new convention.

  • [stale-doc] docs/guides/user/running-agents-locally.md — The "Simulating Fullsend's real customization layers" section provides instructions for using the customized/ overlay without a deprecation notice.
    Remediation: Add a deprecation notice referencing ADR-0064 and pointing to config-driven agent registration.


Labels: PR is documentation-only work establishing deprecation conventions and labeling deprecated features across user-facing guides

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the review comment for full details.

Comment thread docs/guides/dev/cli-internals.md Outdated
Comment thread docs/guides/getting-started/org-mode.md
@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment documentation type/chore Maintenance and housekeeping tasks labels Jul 22, 2026
@rh-hemartin

Copy link
Copy Markdown
Member

/fs-fix remove mentions to ADRs, just that something is deprecated and the alternative.

@fullsend-ai-coder

fullsend-ai-coder Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 7:23 AM UTC · Completed 7:27 AM UTC
Commit: 3db5677 · View workflow run →

Simplify deprecation notices to state only what is deprecated and
what the alternative is, without referencing specific ADR numbers.

Addresses review feedback on #5462
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 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):

  1. ADR references in CONTRIBUTING.md deprecation convention template (CONTRIBUTING.md): Removed ADR-NNNN link from blockquote template, removed 'Link to the ADR' key element, removed '(ADR 0055)' from inline annotation example, and changed 'When an ADR deprecates' to 'When a feature is deprecated'
  2. ADR-0055 reference in doc-site.md versioning investigation (docs/doc-site.md): Removed 'in ADR-0055 Phase 3' from the 'When to revisit' paragraph, keeping only the feature name
  3. ADR-0069 reference in cli-internals.md admin install deprecation (docs/guides/dev/cli-internals.md): Removed 'per ADR-0069' from the admin install deprecation notice
  4. ADR-0044 reference in org-mode.md deprecation notice (docs/guides/getting-started/org-mode.md): Removed 'per ADR-0044' from the per-org mode deprecation notice
  5. ADR-0055 references in bring-your-own-agent.md runner_env deprecation (docs/guides/user/bring-your-own-agent.md): Removed '(ADR 0055)' from inline code comment and 'per ADR-0055' from the Deprecated fields blockquote
  6. ADR-0064 references in customizing-agents.md deprecation notices (docs/guides/user/customizing-agents.md): Removed 'per ADR-0064' from both the customized/skills/ and customized/agents/ deprecation notices
  7. ADR-0064 reference in customizing-with-agents-md.md (docs/guides/user/customizing-with-agents-md.md): Removed 'per ADR-0064' from the inline deprecation note, keeping just '(deprecated; use config-driven agent registration instead)'

Tests: passed

Updated by fullsend fix agent

@codecov

codecov Bot commented Jul 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@rh-hemartin
rh-hemartin added this pull request to the merge queue Jul 27, 2026
Merged via the queue into main with commit 68895af Jul 27, 2026
16 checks passed
@rh-hemartin
rh-hemartin deleted the agent/4886-label-deprecated-docs branch July 27, 2026 07:49
@fullsend-ai-retro

fullsend-ai-retro Bot commented Jul 27, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 7:52 AM UTC · Completed 8:03 AM UTC
Commit: 6d7ec23 · View workflow run →

@fullsend-ai-retro

Copy link
Copy Markdown

Retro: PR #5462 — Label deprecated features in user documentation

Workflow timeline:

  1. Jul 14 — Triage agent created issue Clearly label deprecated features in user documentation #4886 from meeting notes ("Clearly label deprecated features in user documentation")
  2. Jul 22 13:31 — Human (rh-hemartin) triggered /fs-code
  3. Jul 22 13:33–13:43 — Code agent (run 29924320201) produced an 8-file commit adding deprecation notices with ADR cross-references
  4. Jul 22 13:44–14:01 — Review agent (run 29925261633) posted 4 findings: 1 medium (ADR-0069 misattributed — should be ADR-0044), 3 low (migration guidance, 2 stale-doc findings outside the PR diff)
  5. Jul 27 07:21 — Human posted /fs-fix remove mentions to ADRs, just that something is deprecated and the alternative.
  6. Jul 27 07:22–07:28 — Fix agent (run 30245882735) removed ADR references from 7 files in one clean iteration
  7. Jul 27 07:44 — Human approved; 07:49 — merged

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation ready-for-review Triggers review agent dispatch requires-manual-review Review requires human judgment type/chore Maintenance and housekeeping tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clearly label deprecated features in user documentation

1 participant