Skip to content

docs: sync landing/README/demos with latest main (720 → 729 tokens) - #560

Merged
jackgranatowski merged 2 commits into
mainfrom
claude/import-performance-impact-ovvjpb
Jul 7, 2026
Merged

jackgranatowski merged 2 commits into
mainfrom
claude/import-performance-impact-ovvjpb

Conversation

@jackgranatowski

@jackgranatowski jackgranatowski commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Context

Follow-up to #552 (merged). Since that merge, PRs #554#559 landed and moved
the documented surface again. This PR restarts fresh off the latest main and
brings our landing page, README, architecture.md, and the API demos back in
sync with the current token/class set.

What changed upstream (and what we updated)

Upstream change Effect on our docs Fix
#557 shipped --sf-fluid-width + --sf-surface-bg-* (and #497/#526/#523) Token count 720 → 729 Updated README (×2) and landing (×3)
State classes namespaced .is-*.sf-is-* Already applied to the merged README/architecture by upstream No change needed — verified
Background layer API rename (.sf-bg--* dropped, .sf-theme-* added) Our docs never referenced those classes No change needed — verified
Utility layer active set (heading/text-size/hover/list-reset/marker/selection/sticky) architecture.md file-map still said "rest commented" Listed the full active set
New --sf-surface-bg-* knobs broke demos/generate.mjs (unhandled-knob assertion) Demos stale at 320 classes / 720 tokens Added 7 curated background overrides + skipped the animation shorthand, regenerated

Result

  • Token count reads 729 everywhere (README, landing, demos) — matches
    docs/api-index.json and the generated docs/tokens.md.
  • demos/generate.mjs builds again; the full-API demo reports 324 bundled
    classes / 729 tokens
    (was 320 / 720).
  • Verified against source: color knobs still 20, cascade layers still 15,
    component surface still .sf-btn + .sf-card.

Checks

Local gates green: check:version, check:llm-guide, check:registry,
audit:check (729 tokens, 288 .sf-, 28 .sf-is-).

🤖 Generated with Claude Code


Generated by Claude Code

Summary by CodeRabbit

  • New Features

    • Expanded the design token system and live demo to show more token options, including new fluid and surface-related values.
    • Added additional theme and layout examples in the demo galleries.
  • Documentation

    • Updated product and framework copy to reflect the latest design token count.
    • Clarified the architecture docs to list the currently active helper set.

Rebased fresh off main after #552 merged. Later PRs (#554#559) grew the
token set to 729 (new --sf-fluid-width and --sf-surface-bg-* knobs from
#557) and renamed state classes to .sf-is-* (already reflected in the
merged docs). Update the remaining stale counts:

- README + landing: 720 → 729 design tokens.
- architecture.md file-map: list the full active utility set
  (heading/text-size/hover/list-reset/marker/selection/sticky).
- demos/generate.mjs: teach it the eight new --sf-surface-bg-* knobs
  (seven curated background overrides + skip the animation shorthand),
  then regenerate: 324 bundled classes / 729 tokens (was 320 / 720).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016WH9Q15j1dZYxqTqMoomxq
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@jackgranatowski, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 50 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9f5b8ef0-701a-4f1c-8d3e-c75146eb46dc

📥 Commits

Reviewing files that changed from the base of the PR and between 627a00c and aa103bc.

📒 Files selected for processing (1)
  • docs/architecture.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/import-performance-impact-ovvjpb

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.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Docs: sync README/landing/demos to 729-token API surface

📝 Documentation 🐞 Bug fix 🕐 20-40 Minutes

Grey Divider

AI Description

• Update published token/class counts to match current 729-token API index.
• Refresh full API demo pages with new layout/macro/theme classes and token sections.
• Fix demo generator overrides to handle new surface background knobs safely.
Diagram

graph TD
  U{{"Upstream token/class set"}} --> R["README.md"] --> L["index.html (landing)"]
  U --> A["docs/architecture.md"]
  U --> G["demos/generate.mjs"] --> D["full-api-demo*.html"]
  G --> O["ultimate-override.css"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Single source of truth for counts (scripted injection)
  • ➕ Eliminates manual 720→729-style edits across README/landing/demos
  • ➕ Reduces risk of stale marketing/docs numbers after upstream merges
  • ➖ Requires adding a small build step or CI task to rewrite/inject values
  • ➖ May be undesirable for a repo emphasizing “no build step” for consumers
2. Generate demo HTML from a template
  • ➕ Avoids hand-editing multiple large HTML files for class/token section changes
  • ➕ Makes adding/removing classes more reliable and diff noise smaller
  • ➖ Introduces/strengthens a codegen workflow that must be maintained
  • ➖ Template changes can be harder to review than direct HTML edits
3. CI gate: validate docs counts against docs/api-index.json
  • ➕ Keeps current workflow, but prevents merges with stale counts
  • ➕ Low implementation complexity (simple assertion script)
  • ➖ Doesn’t auto-fix; still requires manual updates when it fails
  • ➖ Adds another CI check to maintain

Recommendation: The PR’s approach (explicitly syncing docs + updating the generator to understand new knobs) is the right immediate fix to restore consistency. For longer-term maintenance, consider adding a lightweight CI validation that compares published counts against docs/api-index.json; it preserves the no-build philosophy while preventing future drift.

Files changed (7) +91 / -39

Bug fix (1) +9 / -0
generate.mjsHandle new surface background knobs in override generator +9/-0

Handle new surface background knobs in override generator

• Adds a skip reason for the surface background animation shorthand token and introduces curated override values for the new --sf-surface-bg-* knobs so demo generation doesn’t fail assertions and produces meaningful visuals.

demos/generate.mjs

Documentation (6) +82 / -39
README.mdBump documented token count to 729 +2/-2

Bump documented token count to 729

• Updates README marketing copy and the “What’s inside” section to reflect 729 design tokens instead of 720, aligning with the current API index.

README.md

full-api-demo-with-overrides.htmlSync overridden full API demo counts and class sections +31/-15

Sync overridden full API demo counts and class sections

• Updates the headline counts (classes/tokens/configurable knobs) and adjusts demo sections to reflect the current class set (e.g., adds sf-fluid-cq, sf-overlay, sf-surface-bg, sf-theme-dark/light) and updated token subsections (fluid + surface background knobs). Also clarifies a comment describing fullscreen-style helpers.

demos/full-api-demo-with-overrides.html

full-api-demo.htmlSync baseline full API demo counts and class sections +31/-15

Sync baseline full API demo counts and class sections

• Updates displayed bundle counts to 324 classes / 729 tokens and expands the rendered class tiles and token reference sections to match the latest API surface (fluid width token and surface background knobs, plus theme classes). Also refines a comment about fullscreen-style helpers.

demos/full-api-demo.html

ultimate-override.cssExtend ultimate override coverage for new fluid/surface tokens +14/-3

Extend ultimate override coverage for new fluid/surface tokens

• Updates coverage counts, adds an override for --sf-fluid-width, and adds explicit overrides for the new surface background tokens while documenting --sf-surface-bg-animation as intentionally not overridden.

demos/ultimate-override.css

architecture.mdDocument full active utilities subset +1/-1

Document full active utilities subset

• Updates the utilities layer description to list the complete active curated subset (heading/text-size/hover/list-reset/marker/selection/sticky) instead of implying most are commented out.

docs/architecture.md

index.htmlSync landing page token count (meta + hero + stats) +3/-3

Sync landing page token count (meta + hero + stats)

• Updates the landing page meta description, hero lede, and stats strip from 720 to 729 design tokens to match the current API surface.

index.html

@coderabbitai coderabbitai Bot added the codex label Jul 7, 2026
@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Caution

Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted.

Error details
putComment timed out

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@docs/architecture.md`:
- Line 54: The utilities overview entry uses ambiguous helper names for the
active blocks; update the documentation in the architecture section so the
curated subset names match the active helpers exactly. In the line describing
slashed.utilities, replace the generic marker/selection grouping with the
explicit names used elsewhere, namely marker-colour and alternate-selection, so
the documented structure stays consistent with optional/utilities.css and the
active helper list.
🪄 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: ff245a6a-e94d-4673-b8d5-445fe32852ef

📥 Commits

Reviewing files that changed from the base of the PR and between fd794d3 and 627a00c.

📒 Files selected for processing (7)
  • README.md
  • demos/full-api-demo-with-overrides.html
  • demos/full-api-demo.html
  • demos/generate.mjs
  • demos/ultimate-override.css
  • docs/architecture.md
  • index.html

Comment thread docs/architecture.md Outdated
CodeRabbit flagged docs/architecture.md:54 — the terse 'marker/selection'
labels did not match the block names in optional/utilities.css or the fuller
prose in the same file. Spell them out as marker-colour / alternate-selection.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016WH9Q15j1dZYxqTqMoomxq
@jackgranatowski
jackgranatowski merged commit a96ea7e into main Jul 7, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants