docs: add getting-started, cookbook, and slashed-build skill - #652
Merged
jackgranatowski merged 3 commits intoJul 24, 2026
Conversation
…ed-build skill) Close the "single entry point for AI agents" gaps found auditing the LLM docs: the token layer was complete, but an agent reading only llm-guide.md had no install/getting-started path, no cross-links to the class-based API, and no task-oriented recipes. - docs/getting-started.md: install, bundle choice, boilerplate, dark mode, 6-token rebrand, token-first rule. Multipliers framed as an advanced, opt-in escape hatch — not the default workflow. - docs/cookbook.md: copy-paste task recipes (page shell, stack, card grid, hero, sidebar, prose, surface, buttons, states, rebrand + dark toggle). - .claude/skills/slashed-build/SKILL.md: thin router/"brain" — mental model, build workflow, decision tree, and routing into the CI-gated docs. No duplicated token/class inventories (anti-drift). - llm-guide.md + README: cross-link the new docs and the class-based API. - check-doc-refs.js: scan the skill dir too, so SKILL.md's --sf-*/.sf-* references are drift-guarded like every other doc. check:doc-refs and check:llm-guide both pass (17 docs scanned). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Fad4UDMPgW3dBurUpkJE9d
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughAdds getting-started and cookbook documentation, introduces the ChangesSLASHED documentation workflow
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your trial has ended. Reactivate Greptile to resume code reviews.
Rewrite the skill's doc references from repo-relative paths (../../../docs/*.md) to GitHub blob/tree URLs so the skill keeps its routing when copied into a consumer project — the npm package ships only docs/api-index.json, not the .md docs, so relative links would dangle. A note in the reference map points in-repo users at the local docs/ copies. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Fad4UDMPgW3dBurUpkJE9d
Contributor
Author
|
@coderabbitai review |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/slashed-build/SKILL.md:
- Line 74: Update the “Constrain / centre page content” row to list the complete
modifier class names `.sf-container--narrow`, `.sf-container--wide`, and
`.sf-container--prose` instead of abbreviated variants, while preserving the
existing `.sf-container` reference and layout documentation link.
In `@docs/cookbook.md`:
- Around line 181-185: Update the ARIA examples in the HTML snippet: replace the
bare selected li with an element using an appropriate selectable widget role and
valid ownership context, such as an option inside a listbox, and make the
disabled button behaviorally inactive by using native disabled in addition to
aria-disabled or otherwise preventing activation. Preserve the loading example.
- Around line 8-9: Update the recipe documentation in the hero section and
interactive-states section to explicitly state that recipes using .sf-btn or
.sf-card require the full bundle. Ensure the full-bundle notice is present for
every affected recipe while preserving the existing optimal-bundle guidance for
recipes that do not use those classes.
In `@docs/getting-started.md`:
- Around line 13-14: Update the introductory statement in the getting-started
documentation to scope the no-Node and no-build-step claim to the CDN usage
path. Clarify that the npm path requires npm install and package-subpath
resolution through a package manager or bundler, while preserving the existing
distinction between the two setup paths.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 56c8e042-62f4-48eb-87bd-b282aaa77793
📒 Files selected for processing (6)
.claude/skills/slashed-build/SKILL.mdREADME.mddocs/cookbook.mddocs/getting-started.mddocs/llm-guide.mdscripts/check-doc-refs.js
Four minor doc-quality fixes from PR review: - cookbook.md: correct the interactive-states ARIA example — wrap the aria-selected item in a role="listbox"/role="option" pair (a bare <li> cannot carry aria-selected) and use native `disabled` on the button (aria-disabled only exposes state, does not block activation). - cookbook.md: add the missing "requires the full bundle" note to the hero and interactive-states recipes, which use .sf-btn / .sf-card. - getting-started.md: scope the "no Node / no build step" claim to the CDN path; the npm path uses a package manager + bundler. - SKILL.md: spell out the container modifier classes (.sf-container--narrow/--wide/--prose) instead of abbreviating them, so an assistant doesn't emit bare `--narrow` selectors. check:doc-refs passes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Fad4UDMPgW3dBurUpkJE9d
Contributor
Author
|
Addressed all four CodeRabbit review comments in
Generated by Claude Code |
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
2 participants
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.
Summary
Adds three new documentation artifacts to improve onboarding and AI-assisted development:
docs/getting-started.md— Entry point for new users: how to load SLASHED, bundle selection, minimal boilerplate, dark mode setup, rebranding in six tokens, and the core principle (never hardcode visual values).docs/cookbook.md— Task-oriented recipes for common builds: page shell, vertical rhythm, card grids, hero sections, sidebar layouts, prose articles, surfaces, buttons, interactive states, rebranding + dark-mode toggle, and local tweaks without new tokens. Every recipe is copy-paste ready..claude/skills/slashed-build/SKILL.md— AI assistant skill that teaches the SLASHED mental model (token-first, BEM-first, classless base elements) and routes to authoritative reference docs. Includes the five core principles, build workflow, decision tree, and reference map.Also updates:
docs/llm-guide.mdheader with pointers to getting-started and cookbookREADME.mdto link the new guides in the documentation tablescripts/check-doc-refs.jsto include the skill directory in doc reference validationThese docs are not generated artifacts — they are hand-written, authoritative references that CI validates via
check:doc-refsto ensure all token/class references are live.Type
Checklist
feat:,fix:,docs:, …) — enforced by commitlintnpm run lint:csspasses (stylelint) — no CSS changesnpm run buildrebuildsdist/— no source changesnpm testpasses (unit + Playwright e2e) — no code changescore/*.css,optional/*.css, ortoken-registry.jsonchanged — no token changes; llm-guide.md updated with pointersCHANGELOG.mdupdated under## [Unreleased]— user-facing docs additionNotes
All token and class references in the new docs are validated by the existing
check:doc-refsCI gate (extended to include.claude/skills/slashed-build/). The docs are authoritative, not generated — they live alongside the source and are kept in sync by human review and CI validation.https://claude.ai/code/session_01Fad4UDMPgW3dBurUpkJE9d
Summary by CodeRabbit
data-theme, rebranding with reserved color overrides, and basic HTML setup.