docs: promote Claude Code skill into the README overview - #177
Merged
Merged
Conversation
Surfaces the v0.5.0 install-skill feature where prospective users decide
whether SignalForge is for them. Three edits:
1. New "Drives end-to-end from Claude Code" bullet in § What it does
(8th entry in the feature list), linking to docs/skills.md as the
deep dive.
2. New top-level § Claude Code section between § How it works and §
Supported warehouses — gives the install command, three example
prompts ("draft tests for dim_customers", "prune my schema.yml",
"run the demo"), an explanation of what Claude actually does with
the skill (picks subcommand + flags, runs the pipeline, explains
the diff), and a pointer to docs/skills.md for the full reference
(install path, 7-step workflow, demo flows, parity gate, clauditor
self-grade).
3. Tightens the pre-existing Quick-start install hint at Step 1 to
cross-link to the new § Claude Code section rather than be the
first introduction.
Also adds an [Unreleased] § Docs CHANGELOG bullet recording the
overview promotion (the v0.5.0 entry already documents the feature
itself).
docs/skills.md is the deep dive — no change required there, it
already covers everything the new README section points to. mkdocs.yml
nav already has 'Claude Code Skill: skills.md' from v0.5.0.
`uv run --only-group docs mkdocs build` passes; all warnings are
pre-existing (per docs-publishing.md, repo-internal plans/super/ links
are deliberately not in the built site).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughREADME and CHANGELOG are updated to document the Claude Code skill integration. A new dedicated section in README explains installation, supported prompts, and diff reporting. "What it does" now links to this section, and Quick start directs users to install the skill from the dbt project root. CHANGELOG documents these documentation changes. ChangesClaude Code Documentation Expansion
Estimated code review effort🎯 2 (Simple) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Surfaces the v0.5.0 `install-skill` feature where prospective users decide whether SignalForge is for them. Today the skill is only mentioned once, inside Step 1 of Quick start — easy to miss when skimming for "is this for me?"
Three edits to README.md:
New bullet in § What it does (8th entry in the feature list) — "Drives end-to-end from Claude Code." Links to `docs/skills.md` as the deep dive.
New top-level § Claude Code section between § How it works and § Supported warehouses. Gives the install command, three example prompts ("draft tests for `dim_customers`", "prune my `schema.yml`", "run the demo"), an explanation of what Claude actually does (picks subcommand + flags, runs the pipeline, explains the kept / kept-uncertain / dropped / flagged diff), and a pointer to `docs/skills.md` for the full reference.
Tightens the pre-existing Quick-start install hint to cross-link to the new § Claude Code section rather than be the first introduction. Avoids redundancy without losing the install-moment reminder.
One edit to CHANGELOG.md: new `[Unreleased]` § Docs bullet recording the overview promotion. The v0.5.0 entry already documents the feature itself.
No changes needed elsewhere:
Validation: `uv run --only-group docs mkdocs build` passes — all warnings pre-existing per `.claude/rules/docs-publishing.md` (repo-internal `plans/super/` links deliberately not in the site).
🤖 Generated with Claude Code
Summary by CodeRabbit