Skip to content

Docs/API sync cleanup: fix phantom refs + retire unused border-style tokens - #270

Merged
jackgranatowski merged 2 commits into
mainfrom
chore/docs-api-sync-cleanup
Jun 8, 2026
Merged

Docs/API sync cleanup: fix phantom refs + retire unused border-style tokens#270
jackgranatowski merged 2 commits into
mainfrom
chore/docs-api-sync-cleanup

Conversation

@jackgranatowski

@jackgranatowski jackgranatowski commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

This pull request was created by @kiro-agent on behalf of @jackgranatowski 👻

Comment with /kiro fix to address specific feedback or /kiro all to address everything.
Learn about Kiro Web


Summary

Brings the docs back into 100% sync with the framework API and removes dead-weight tokens, in two commits:

1. fix(docs) — correct phantom token/class references

Several docs referenced tokens/classes that don't exist in the CSS sources:

  • docs/demo.html
    • --sf-pancake-min-height → removed (dead inline var; .sf-pancake hardcodes min-height)
    • --sf-brand--sf-prose-marker-color (the real token, defaults to --sf-color-primary)
    • --sf-color-X / .sf-grid-N--sf-color-* / .sf-grid-* wildcard notation
  • docs/test-coverage.html
    • --sf-measure--sf-container-prose (the real reading-measure token)

2. feat(tokens)! — remove unused --sf-border-style-soft / --sf-border-style-dotted

These two tokens were never consumed by any core/optional rule (only a single demo page referenced them). They added public API surface without theming value, since dashed/dotted are short universal CSS keywords. The global knob --sf-border-style (consumed by every border shorthand and base element border) is kept.

  • Removed declarations from core/tokens.css + the commented mirror in optional/theme-example.css
  • Fixed a token-inventory comment that also listed a never-existent --sf-border-style-strong
  • Demo now uses literal dotted/dashed keywords
  • Regenerated registry.json, tokens.md, token-index.* (771 → 769 tokens)
  • Resynced the hand-authored test-coverage-6 token-reference array and the token-api snapshot lock

⚠️ BREAKING CHANGE: --sf-border-style-soft and --sf-border-style-dotted are removed with no alias. Use the CSS keywords dashed / dotted directly, or set --sf-border-style globally.

Testing

  • npm run audit:check → OK (769 tokens, 173 .sf-, 40 .is-)
  • Token-API snapshot logic verified in Node → matches (0 added / 0 removed)
  • test-coverage-6 array vs registry → exact match (769 = 769)
  • Repo-wide grep → no residual references to the removed tokens (except historical CHANGELOG.md, which is release-it–generated)
  • Pre-commit hooks (stylelint + artifact rebuild) passed on both commits

Notes / limitations

  • The full Playwright suite was not run — the sandbox has no browsers installed. Pure-Node checks (audit, snapshot, sync) were run instead. CI should exercise the browser tests.
  • dist/* is gitignored (built at release time), so no bundle changes are included here.

Summary by CodeRabbit

  • Documentation

    • Updated token documentation and registry to reflect removal of border-style token variants
    • Refined demo descriptions to clarify component behavior for layout and prose features
  • Chores

    • Removed --sf-border-style-soft and --sf-border-style-dotted border-style tokens from the public token set

kiro-agent and others added 2 commits June 8, 2026 11:58
demo.html and test-coverage.html referenced tokens/classes that do not exist in the CSS sources:
- --sf-pancake-min-height: dead inline var; .sf-pancake hardcodes min-height
- --sf-brand: replaced with the real --sf-prose-marker-color
- --sf-color-X / .sf-grid-N: changed to --sf-color-* / .sf-grid-* wildcard notation
- --sf-measure: replaced with the real --sf-container-prose token

Co-authored-by: Jack Granatowski <contact@codeslash.net>
…tyle-dotted

These two tokens were never consumed by any core or optional CSS rule;
the only references were a single demo page. They added public API
surface (docs, snapshot, back-compat liability) without theming value,
since 'dashed'/'dotted' are short universal CSS keywords. The global
knob --sf-border-style (consumed by every border shorthand and base
element border) is kept.

- Remove declarations from core/tokens.css and the commented mirror in
  optional/theme-example.css
- Fix the token-inventory comment that also listed a never-existent
  --sf-border-style-strong
- Update the demo to use literal dotted/dashed keywords
- Regenerate registry.json, tokens.md, token-index.* (771 -> 769)
- Resync the test-coverage-6 token reference array and the token-api
  snapshot lock

BREAKING CHANGE: --sf-border-style-soft and --sf-border-style-dotted are
removed with no alias. Use the CSS keywords 'dashed' / 'dotted' directly,
or set --sf-border-style globally.

Co-authored-by: Jack Granatowski <contact@codeslash.net>
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 59150f25-90a4-4ce2-a92a-66a7904ffd49

📥 Commits

Reviewing files that changed from the base of the PR and between aec4528 and 52be5c8.

📒 Files selected for processing (11)
  • core/tokens.css
  • docs/demo.html
  • docs/registry.json
  • docs/test-coverage-2-typography.html
  • docs/test-coverage-6-token-reference.html
  • docs/test-coverage.html
  • docs/token-index.json
  • docs/token-index.md
  • docs/tokens.md
  • optional/theme-example.css
  • tests/token-api.snapshot.json
💤 Files with no reviewable changes (2)
  • tests/token-api.snapshot.json
  • optional/theme-example.css

📝 Walkthrough

Walkthrough

This PR removes two border-style custom properties (--sf-border-style-soft and --sf-border-style-dotted) from the core token definitions and systematically updates all references across documentation, test coverage pages, generated indexes, and snapshots to reflect the reduced token set.

Changes

Border-style token removal

Layer / File(s) Summary
Core token definition removal
core/tokens.css
Removes --sf-border-style-soft and --sf-border-style-dotted from PUBLIC token documentation and deletes these custom properties from the token definition block, leaving only --sf-border-style: solid.
Demo content and styling updates
docs/demo.html, docs/test-coverage-2-typography.html
Updates demo documentation text for grid behavior, refines prose marker color description, removes inline --sf-pancake-min-height custom property, improves theme customizer comments, and replaces deprecated border-style demo examples with keyword-based alternatives.
Test coverage and token reference pages
docs/test-coverage-6-token-reference.html, docs/test-coverage.html
Regenerates the TOKENS array to exclude removed tokens and changes main container layout from --sf-measure to --sf-container-prose.
Generated documentation indexes
docs/registry.json, docs/token-index.json, docs/token-index.md, docs/tokens.md
Updates all generated token metadata, counts (771 → 769), and tier breakdowns to reflect token removal and removes the two deleted entries from token lists.
Reference comments and snapshots
optional/theme-example.css, tests/token-api.snapshot.json
Removes commented border-style token entries from reference block and deletes the two tokens from API snapshot JSON.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • codeslash-dev/SLASHED#224: Conflicts at core/tokens.css border-style custom properties—this PR removes --sf-border-style-soft and --sf-border-style-dotted while that PR adds or expands border-style tokens including those same variants.
  • codeslash-dev/SLASHED#265: Token-index generator inputs—this PR removes --sf-border-style-soft and --sf-border-style-dotted, which directly affects the generated token counts and contents produced by that PR's token-index tooling.
  • codeslash-dev/SLASHED#253: This PR removes the border-style tokens and updates test coverage pages (docs/test-coverage-2-typography.html, docs/test-coverage-6-token-reference.html) that were added in that PR to reflect the removals.
🚥 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 accurately captures the main objectives of the PR: syncing documentation with the API and removing two unused border-style tokens.
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 chore/docs-api-sync-cleanup

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.

❤️ Share

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

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.

2 participants