Skip to content

docs: post-encoding-loop refresh — README + dev-loop.md + dev-loop.svg#116

Merged
emeraldleaf merged 1 commit into
mainfrom
docs/post-encoding-loop-refresh
Jun 5, 2026
Merged

docs: post-encoding-loop refresh — README + dev-loop.md + dev-loop.svg#116
emeraldleaf merged 1 commit into
mainfrom
docs/post-encoding-loop-refresh

Conversation

@emeraldleaf
Copy link
Copy Markdown
Owner

@emeraldleaf emeraldleaf commented Jun 5, 2026

Summary

Three doc sites had drift from the recent encoding-loop work (PRs #114 + #115). This refreshes all three together so the project's public-facing description matches the deployed reality.

Changes

`README.md`

  • Line 18 "Two AI reviewers" callout: expanded `.claude/skills/` → the full `.claude/` folder (agents, skills, slash commands, hook scripts, hook + permission wiring). That's what Claude Code actually loads every session, and naming the full meta-layer matters because it's what gets ported between projects.
  • NEW: "Continuous Rule Encoding" callout right after — introduces the loop + 3-tier enforcement spectrum + lean-CLAUDE.md discipline (~300 lines, CI soft cap 400, hard fail 500) + the 5 encoding surfaces + cross-links to all five slash commands (`/feature-spec`, `/article-audit`, `/check-rules`, `/new-feature-slice`, `/sync-status`). Points readers at `docs/dev-loop.md` for full mechanics and `docs/dev-loop-scaffolding.svg` for the scaffolding diagram.

`docs/dev-loop.md`

`docs/dev-loop.svg`

The rendered diagram embedded on GitHub. Three targeted edits:

What this is NOT

  • Not a full SVG regeneration. The diagram has other minor staleness (CLAUDE.md "25 KB" annotation is outdated since the trim; integration tests list shows only Catalog + Order while CI now runs 4 slices). Targeted surgery, not a rewrite. A full SVG refresh is a separate PR if it becomes valuable.

Verification

  • `broken-link` audit: exit 0 on the changed markdown files
  • All cross-references in the new README callout resolve (`/feature-spec`, `/article-audit`, `docs/dev-loop.md`, `docs/dev-loop-scaffolding.svg`, etc.)

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Documentation
    • Enhanced documentation of the continuous rule encoding process explaining how findings are translated into enforced conventions and automated checks.
    • Added documentation for two new developer workflow commands: feature specification drafting and article audit verification capabilities.

Three doc sites had drift from the recent encoding-loop work:

README.md (line 18 "Two AI reviewers" callout)
- Old: lists only .claude/skills/ as what Claude Code reads
- New: lists the full .claude/ folder (agents, skills, slash commands,
  hook scripts, hook + permission wiring) — the meta-layer that gets
  ported between projects
- ADDED a new "Continuous Rule Encoding" callout right after, introducing
  the loop + 3-tier enforcement spectrum + lean-CLAUDE.md discipline
  (~300 lines, CI soft cap 400, hard fail 500) + the 5 encoding surfaces
  + cross-links to /feature-spec, /article-audit, /check-rules,
  /new-feature-slice, /sync-status. Points at docs/dev-loop.md for full
  mechanics and docs/dev-loop-scaffolding.svg for the scaffolding diagram.

docs/dev-loop.md (Slash commands table)
- Was missing /feature-spec (just landed in #115) and /article-audit
  (landed earlier this week)
- Added both with their actual one-line descriptions

docs/dev-loop.svg (rendered diagram people see on GitHub)
- Stage 1 "PostToolUse" hooks list: added check-file-moves.sh (the hook
  added in #114 for git-mv/git-rm detection)
- Stage 1 "Slash commands" list: added /feature-spec and /article-audit
  alongside the existing 3; shifted Agents/Skills/Secondary-reviewer
  positions down by 54px to make room
- Encoding loop "Encode in:" footer: was 4 surfaces (CLAUDE.md +
  .coderabbit.yaml + arch-reviewer Pattern Checklist + skill), now 5
  surfaces (added "docs + paired diagrams" as surface 5, shortened
  labels to fit). Title now reads "Encode in 1+ of 5 surfaces" to
  clarify the surface count

What this is NOT:
- Not a full dev-loop.svg regeneration — the SVG also has other minor
  staleness (CLAUDE.md size annotation "25 KB" is outdated since the
  trim; integration tests list only shows Catalog + Order while CI now
  runs 4 slices). Targeted surgery here, not a rewrite.

Verification:
- broken-link guard: exit 0 on the changed markdown files
- All cross-references resolve

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 5bbfdb9d-deee-49c2-aa94-0b14cfc3e1b7

📥 Commits

Reviewing files that changed from the base of the PR and between 4bdc409 and d3c778f.

⛔ Files ignored due to path filters (1)
  • docs/dev-loop.svg is excluded by !**/*.svg
📒 Files selected for processing (2)
  • README.md
  • docs/dev-loop.md

Walkthrough

The pull request updates documentation to explain the continuous rule-encoding development loop and its Stage 1 tools. README.md expands the description of AI reviewer inputs to include the full .claude/ folder contents and introduces a continuous rule-encoding feedback loop. docs/dev-loop.md adds two new slash commands—/feature-spec and /article-audit—to the Stage 1 slash commands section.

Changes

Documentation updates for continuous rule-encoding dev loop

Layer / File(s) Summary
Dev loop tooling and continuous rule-encoding documentation
README.md, docs/dev-loop.md
README expands the AI reviewer's inputs to include agents, skills, commands, hooks, and wiring, and adds a new bullet explaining the continuous rule-encoding feedback loop. dev-loop.md documents two new Stage 1 slash commands: /feature-spec (drafts structured feature specs with CLAUDE.md constraints) and /article-audit (audits external articles and emits coverage verdicts).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • emeraldleaf/NextAurora#115: Introduces the /feature-spec slash command implementation that is documented in this PR's dev-loop.md update.
  • emeraldleaf/NextAurora#87: Introduces the /article-audit slash command implementation that is documented in this PR's dev-loop.md update.
  • emeraldleaf/NextAurora#114: Updates dev-loop.md's continuous rule-encoding workflow documentation, directly related to the framework described in this PR's README and dev-loop updates.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: post-encoding-loop refresh — README + dev-loop.md + dev-loop.svg' clearly and concisely identifies the main changes: documentation updates across three specific files (README, dev-loop.md, and dev-loop.svg) related to post-encoding-loop refresh.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/post-encoding-loop-refresh

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

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@emeraldleaf emeraldleaf merged commit 5600ca7 into main Jun 5, 2026
7 checks passed
@emeraldleaf emeraldleaf deleted the docs/post-encoding-loop-refresh branch June 5, 2026 14:32
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