Skip to content

kb(skills): add KB editing conventions scan to kb-pr-review Derek - #1211

Merged
hilram7 merged 3 commits into
devfrom
skills/kb-pr-derek-updates-2026-07
Jul 10, 2026
Merged

kb(skills): add KB editing conventions scan to kb-pr-review Derek#1211
hilram7 merged 3 commits into
devfrom
skills/kb-pr-derek-updates-2026-07

Conversation

@hilram7

@hilram7hilram7 commented Jul 10, 2026•
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

Adds a 12-item mechanical scan checklist to the Derek step of kb-pr-review, and introduces a shared KB editing conventions rulebook at .claude/references/ that KB claude skills can point at.

Changes

  • Adds .claude/references/kb-editing-conventions.md — the canonical KB editing rulebook (structure, step condensation, list types, sentence rules, callouts, bolding, overview quality, links, placeholders, formatting) for skills to reference one source.
  • Adds a KB Editing Conventions Scan (Derek subsection) table to .claude/skills/kb-pr-review/SKILL.md — a 12-row mechanical sweep that runs on every file during Derek review. Rows map to the rulebook:
    • NOTE-in-list 4-space indentation (build-breaker)
    • Bare/symptom-style Overview flagging
    • <!-- link removed --> recoverable target search
    • UI-name bolding consistency within a file
    • Trailing periods in table cells
    • Abrupt "Click X." step endings
    • Standard Netwrix Support link convention
    • Step N — em-dash subheading normalization
    • Repetitive command-run step condensation
    • Result-in-numbered-list restructuring
    • Every Instructions subheading must contain an action
    • Nested numbered sub-lists converted to dashes

The inline scan list stays deterministic and always-in-context; the rulebook provides the "why" and edge-case guidance. New patterns should be added to both the KB skill and editing conventions .md files in the same PR.

@hilram7
kb(skills): add KB editing conventions scan to kb-pr-review Derek
1d97670
Adds a mechanical 12-item scan checklist under the Derek step in
kb-pr-review. Codifies patterns surfaced during Change Tracker batch
3a/3b review so future batches auto-catch them:
- NOTE-in-list 4-space indentation (build-breaker)
- Bare/symptom-style Overview flagging
- <!-- link removed --> recoverable target search
- UI-name bolding consistency within a file
- Trailing periods in table cells
- Abrupt "Click X." step endings
- Standard Netwrix Support link convention
- Step N em-dash subheading normalization
- Repetitive command-run step condensation
- Result-in-numbered-list restructuring
- Every Instructions subheading must contain an action
- Nested numbered sublists converted to dashes
Mirrors the same checklist added to the user-side kb-pr-open skill
so the two skills stay in sync on Derek expectations.
@hilram7
hilram7 marked this pull request as ready for review July 10, 2026 20:58
@hilram7
kb(skills): move KB editing conventions rulebook into shared references
a00e847
Adds the canonical rulebook at .claude/references/kb-editing-conventions.md
so both kb-pr-review and kb-pr-open (and future KB tooling) can reference
one source rather than any single skill "owning" it. Strips the memory
frontmatter and rewrites the intro so the document reads as a standalone
project reference.
Updates the kb-pr-review Derek scan subsection to point at the new path
instead of the reviewer's personal memory file.
@hilram7
Update kb-editing-conventions.md by trimming content
36778bf
Removed related memories and evolution sections
@github-actions

github-actionsBot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Code Review

No correctness issues found.

This PR changes only two Markdown files under .claude/ — a new reference rulebook (.claude/references/kb-editing-conventions.md) and the kb-pr-review skill instructions (.claude/skills/kb-pr-review/SKILL.md). There are no changes to code, Docusaurus config (products.js, docusaurus.config.js, sidebars), the KB copy pipeline/build scripts, or GitHub Actions workflows, so there is nothing in scope for bugs, injection/secrets, build/routing breakage, or workflow trigger/permission/secret concerns.

A couple of notes for completeness:

  • .claude/ is outside the Docusaurus build tree, so these files cannot affect the build or routing.
  • The skill update points to .claude/references/kb-editing-conventions.md, which this same PR creates — the cross-reference is internally consistent.

Documentation content and style were intentionally not reviewed here (handled by a separate workflow).

@hilram7
hilram7 merged commit 8c2dafa into devJul 10, 2026
7 checks passed
@hilram7
hilram7 deleted the skills/kb-pr-derek-updates-2026-07 branch July 10, 2026 21:27
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@hilram7