Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions internal/scaffold/fullsend-repo/skills/code-review/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,12 @@ readability or correctness.
- Do documentation files reference behavior, APIs, or configurations
Comment thread
rh-hemartin marked this conversation as resolved.
changed by this PR?
- Are any docs now stale as a result of the change?
- **Rename/deprecation completeness:** When a PR renames or removes an
identifier, grep for stale references using a bare-word pattern
(`\bOLD_NAME\b`) in addition to any syntax-specific pattern (e.g.,
`OLD_NAME:` for YAML). Documentation files (`.md`, `.adoc`, `.rst`)
often reference field names in prose without syntax suffixes and will
be missed by syntax-specific patterns alone.

#### Cross-repo contracts

Expand Down
9 changes: 9 additions & 0 deletions internal/scaffold/fullsend-repo/skills/docs-review/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,15 @@ and exit — there is nothing to check.

Write a shell script that takes the identifiers from step 2 and
greps for each one across the documentation files from step 3.

**Rename/deprecation PRs:** When a PR renames or removes an identifier,
Comment thread
rh-hemartin marked this conversation as resolved.
use a bare-word pattern (`\bOLD_NAME\b`) in addition to any
syntax-specific pattern (e.g., `OLD_NAME:` for YAML). Documentation
files often reference field names in prose without syntax suffixes and
will be missed by syntax-specific patterns alone. See the
`docs-currency` sub-agent's "Rename/deprecation pattern strategy"
Comment thread
rh-hemartin marked this conversation as resolved.
Comment thread
rh-hemartin marked this conversation as resolved.
section for the full approach.

Run the script in a single Bash call:

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,21 @@ references to renamed/removed identifiers.
Extract identifiers from the diff, then search documentation files for
references. Flag docs that reference identifiers modified or removed in
this PR.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] design-direction

The new Rename/deprecation pattern strategy section is appended to docs-currency.md but is not referenced by docs-review/SKILL.md step 4, where the grep script is constructed. The sub-agent will still see the guidance since it reads its full prompt, so the integration gap is minor.

Suggested fix: Consider adding a cross-reference to the pattern strategy section in docs-review/SKILL.md step 4.


## Rename/deprecation pattern strategy

Comment thread
rh-hemartin marked this conversation as resolved.
When a PR renames or removes an identifier (config key, CLI flag, API
field, function name, etc.), search for stale references using **both**
broad and syntax-specific grep patterns:

1. **Bare-word pattern** (`\bOLD_NAME\b`) — catches all mentions
including prose, comments, backtick-wrapped references, and code.
Run this first and evaluate hits in context.
2. **Syntax-specific pattern** (e.g., `OLD_NAME:` for YAML keys,
`--OLD_NAME` for CLI flags) — catches structured usage in config
and code files.

Documentation files (`.md`, `.adoc`, `.rst`) frequently reference field
names in prose without syntax-specific suffixes (e.g., "set the
`repository` field"). Always include the bare-word pattern when scanning
these file types — a syntax-specific pattern alone will miss them.
Loading