Skip to content

docs: add deprecation banner to user-facing docs (Sprint 1 Track 1)#61

Merged
suzuke merged 1 commit into
mainfrom
docs/sprint-1-banner-audit
Apr 27, 2026
Merged

docs: add deprecation banner to user-facing docs (Sprint 1 Track 1)#61
suzuke merged 1 commit into
mainfrom
docs/sprint-1-banner-audit

Conversation

@suzuke

@suzuke suzuke commented Apr 27, 2026

Copy link
Copy Markdown
Owner

Summary

Aligns user-facing docs with README's deprecation notice. Internal design docs unchanged per Sprint 1 scope. See docs/ts-team-sprint-0-2026-04-27-wrap.md for context.

Banner placement: directly after each H1, before existing content (in some cases before existing metadata blocks like ROADMAP's "Last updated" line — banner stays at top).

Per-doc choices

Doc Banner type Rationale
cli.md / cli.zh-TW.md standard reference doc; users on existing installs need it
configuration.md / configuration.zh-TW.md standard same
features.md / features.zh-TW.md standard + feature-surface caveat future agend-terminal features may differ
plugin-development.md standard + plugin-protocol caveat plugin protocol may differ in new repo
ROADMAP.md / ROADMAP.zh-TW.md standard + historical-snapshot note roadmap captures v1.12.0 state, future direction is in agend-terminal
SECURITY.md / SECURITY.zh-TW.md standard + reports-still-accepted README explicitly continues security fixes; this doc remains the report channel
CHANGELOG.md / CHANGELOG.zh-TW.md standard + future-entries-scope future entries cover security fixes and backend CLI compat only

zh-TW versions translate banner body to 繁體中文 while retaining English for GitHub URLs (agend-terminal) and brand keywords.

Hard rule (general's explicit instruction)

No internal design docs touched. Verified via git diff --name-only origin/main:

docs/CHANGELOG.md
docs/CHANGELOG.zh-TW.md
docs/ROADMAP.md
docs/ROADMAP.zh-TW.md
docs/SECURITY.md
docs/SECURITY.zh-TW.md
docs/cli.md
docs/cli.zh-TW.md
docs/configuration.md
docs/configuration.zh-TW.md
docs/features.md
docs/features.zh-TW.md
docs/plugin-development.md

None of these are touched: superpowers/, specs/, fix-plan.md, p4.1-split-plan.md, design-ux-pain-points.md, rebrand-plan.md, multi-backend-feasibility.md, plugin-adapter-architecture.md, approval-system-analysis.md, context-rotation-design.md, cross-cli-research.md, cross-instance-messaging.md, feature-roadmap.md, issue-evaluations.md, token-overhead-report*.md. Reviewer can re-confirm with the same command.

Stats

  • 13 files changed, 102 insertions(+). Pure banner additions, no content rewrite.

Test plan

  • git diff --name-only origin/main confirms only user-facing docs touched
  • Banner placement: directly after H1 in every modified file (verified by reading the resulting first ~10 lines of each)
  • zh-TW translations preserve GitHub URLs / agend-terminal keyword in English
  • N/A vitest / tsc — pure docs change

🤖 Generated with Claude Code

Aligns user-facing docs with README's deprecation notice. Internal
design docs unchanged per Sprint 1 scope. See
docs/ts-team-sprint-0-2026-04-27-wrap.md for context.

Banner placement: directly after each H1, before existing content.

Per-doc tweaks:
- cli / configuration / plugin-development / features (+ zh-TW pairs):
  standard banner pointing to agend-terminal.
- features (+ zh-TW): banner closes with a note that the feature surface
  documented here is `@suzuke/agend`-specific and may differ in
  agend-terminal.
- ROADMAP (+ zh-TW): banner notes the roadmap captures planning state
  at v1.12.0 and is retained for historical reference; future direction
  lives in agend-terminal.
- SECURITY (+ zh-TW): per-doc nuance — security reports for
  `@suzuke/agend` are still accepted (README explicitly continues
  security fixes); new code reports should target agend-terminal.
- CHANGELOG (+ zh-TW): banner clarifies future entries cover security
  fixes and backend CLI compatibility only.

13 files changed, 102 insertions(+). Pure banner additions, no content
rewrite. zh-TW versions translate banner body but retain English for
GitHub URLs and agend-terminal keyword.

Internal design docs explicitly untouched (verified via
`git diff --name-only origin/main`):
superpowers/, specs/, fix-plan.md, p4.1-split-plan.md,
design-ux-pain-points.md, rebrand-plan.md, multi-backend-feasibility.md,
plugin-adapter-architecture.md, approval-system-analysis.md,
context-rotation-design.md, cross-cli-research.md,
cross-instance-messaging.md, feature-roadmap.md, issue-evaluations.md,
token-overhead-report*.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@suzuke suzuke merged commit 38ec6aa into main Apr 27, 2026
1 check passed
@suzuke suzuke deleted the docs/sprint-1-banner-audit branch April 27, 2026 03:41
suzuke added a commit that referenced this pull request Apr 27, 2026
…al (#62)

Sprint 1 outcome: Track 1 (deprecation banner on 13 user-facing docs,
PR #61) and Track 2 (3 labels created + 5 issues retro-labelled +
ISSUE_TEMPLATE redirect, PR #60) both shipped. Wall time ~10m, 0 open
issues / 0 open PRs at wrap.

Includes Sprint 2 candidate proposal: docs/migration-to-agend-terminal.md
as the canonical TS→Rust migration guide, in response to a cross-team
dependency request from dev-lead (agend-terminal Sprint 24 docs scope).
Pending general align on scope and timing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant