Skip to content

docs(v0.35.3): comprehensive audit — sweep /trigger→/listen + add missing feature coverage#473

Merged
Nathan Schram (nathanschram) merged 1 commit into
devfrom
feature/v0.35.3-doc-audit
May 4, 2026
Merged

docs(v0.35.3): comprehensive audit — sweep /trigger→/listen + add missing feature coverage#473
Nathan Schram (nathanschram) merged 1 commit into
devfrom
feature/v0.35.3-doc-audit

Conversation

@nathanschram
Copy link
Copy Markdown
Member

Summary

Audited every issue in the v0.35.3 milestone (26 issues) against the full repo documentation surface and closed the gaps. Single-commit PR, docs-only — no code or version changes.

Issues whose user-facing docs are touched: #205, #206, #207, #208, #211, #213, #269, #271, #294, #297, #333, #377, #378, #379, #380, #402, #403, #407, #409, #410, #438, #471.

Changes

CHANGELOG.md — added missing entry for #297 (/trigger/listen rename) under ### changes. Note: 3 other issues attached to the v0.35.3 milestone (#224, #228, #239) are not added to CHANGELOG — their fixes shipped in v0.35.0 / v0.35.1rc2 (per close-comment audit). Per release-discipline.md ("no retroactive edits to prior sections"), they remain undocumented in CHANGELOG; their issue close comments cite the actual versions.

/trigger/listen rename sweep (5 files):

  • README.md (commands table, group-chat link)
  • docs/reference/commands-and-directives.md
  • docs/reference/transports/telegram.md (command list + admin note)
  • docs/reference/integration-testing.md (O3 + Q12 test rows)
  • docs/explanation/routing-and-sessions.md (pre-routing filter section)

Runner specs:

How-to guides:

README.md — features bullets (scheduled tasks, inline settings) + 4 command table rows (/usage debug, /listen, Triggers page).

Verified

  • python3 scripts/validate_release.py → passes (rc6 pre-release skip)
  • grep -rnE "/trigger\\b" docs/ README.md → zero non-deprecation hits in production docs (only the legitimate "Renamed from /trigger in v0.35.3" notice in group-chat.md)
  • All 22 issues touched have ≥1 file mention; cross-references resolve to existing anchors
  • AGENTS.md / GEMINI.md show no drift on the same search terms

Out of scope

Test plan

  • CI: format, ruff, ty, pytest matrix, build, lockfile, install-test
  • Visual smoke: render the changed how-to + reference docs (Zensical) and verify section anchors render correctly
  • Cross-doc consistency: grep -rnE "/trigger\\b" docs/ README.md after merge

…sing feature coverage

Audited every issue in the v0.35.3 milestone (26 issues) against the
full repo documentation surface and closed the gaps. Reference issues
covered: #205, #206, #207, #208, #211, #213, #269, #271, #294, #297,
#333, #377, #378, #379, #380, #402, #403, #407, #409, #410, #438, #471.

CHANGELOG.md
- Added missing entry for #297 (/trigger → /listen rename) under
  ### changes. The other "milestone" issues (#224, #228, #239) were
  closed against v0.35.3 for tracking only — their fixes shipped in
  v0.35.0/v0.35.1rc2; per the repo's "no retroactive edits to prior
  sections" rule, they remain undocumented in CHANGELOG (closure
  comments cite the actual versions).

/trigger → /listen rename sweep (#297)
- README.md: command table row, group-chat link
- docs/reference/commands-and-directives.md: command row
- docs/reference/transports/telegram.md: command list + admin note
- docs/reference/integration-testing.md: O3 + Q12 test rows
- docs/explanation/routing-and-sessions.md: pre-routing filter section

Runner specs
- gemini/runner.md: --skip-trust default + opt-out via [gemini]
  skip_trust = false (#471)
- claude/runner.md: post-result idle watchdog + "✓ turn complete"
  meta hint (#333), claude_stream_idle_timeout_ms config + Type-A/B
  classifier (#438)

How-to guides
- schedule-tasks.md: trigger provenance + history + /stats
  triggered/manual breakdown (#271 Tier 3); master pause/resume
  toggle (#294)
- inline-settings.md: new Triggers page (#271 Tier 2 + #294)
- troubleshooting.md: Type-A/B stream idle classification (#438);
  post-result idle watchdog + ✓ turn complete (#333)
- security.md: extended path-redaction coverage (#208); Pi session
  dirs 0o700 (#207)
- subscription-usage.md: /usage debug section (#410)
- operations.md: pause status surfacing in /health (#294); /usage
  debug cross-link (#410); expanded hot-reload list to include
  [progress] (#269), [watchdog] (#333, #438), [footer], [cost]

README.md
- Scheduled tasks bullet: pause/resume toggle (#294); footer
  provenance markers (#271 Tier 3); /stats triggered/manual split
- Inline settings bullet: 📡 Triggers page (#271, #294)
- Commands table: /usage debug (#410); /listen (#297); /config
  Triggers page row

Verified clean:
- python3 scripts/validate_release.py (rc6 pre-release)
- grep -rnE "/trigger\\b" docs/ README.md returns zero non-deprecation
  hits in production docs (test plans and historical results retain
  /trigger by design)
- Cross-references resolve to existing anchors

Plan: ~/.claude/plans/untether-you-are-running-rustling-shannon.md
(also staged in .untether-outbox/v0.35.3-doc-audit-plan.md)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 69d769c3-30eb-45f9-be46-85527f3ff481

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/v0.35.3-doc-audit

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nathanschram Nathan Schram (nathanschram) merged commit bd7acfb into dev May 4, 2026
21 checks passed
@nathanschram Nathan Schram (nathanschram) deleted the feature/v0.35.3-doc-audit branch May 4, 2026 07:06
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