Skip to content

docs: add Bitcount Prop Single font template from befailproof.ai#390

Open
NiveditJain wants to merge 4 commits into
mainfrom
bitcount-font-template
Open

docs: add Bitcount Prop Single font template from befailproof.ai#390
NiveditJain wants to merge 4 commits into
mainfrom
bitcount-font-template

Conversation

@NiveditJain
Copy link
Copy Markdown
Member

@NiveditJain NiveditJain commented May 27, 2026

Adds a reusable Bitcount Prop Single font template under templates/bitcount-font/, capturing the title/wordmark treatment from befailproof.ai so the exact settings can be reused elsewhere.

Contents

  • bitcount.css.bitcount-title class + tunable :root knobs (--title-scale 0.9, --title-squish 0.9, --title-tracking 0.08em) + a self-host @font-face. Framework-agnostic.
  • fonts.ts.example — Next.js next/font/google loader (axes: [ELSH], exposes --font-bitcount). Uses the .ts.example extension so the repo tsc/eslint skip it.
  • preview.html — self-contained demo page (loads the font via the validated Google Fonts CDN URL plus the artifact bitcount.css) showing .bitcount-title at fluid sizes.
  • README.md — usage for Next and non-Next, knob table, provenance.

Fine-tuned instance

font-variation-settings: "wght" 417, "ELSH" 55 (slnt 0), scaleX(0.9), letter-spacing: 0.08em, lowercase.

Verification

Rendered preview.html on a local server and captured screenshots across 320 / 375 / 768 / 1280 / 1920px viewports with a headless browser — the dot-matrix Bitcount font loads and the treatment scales cleanly at every size, with no console errors.

Provenance / caveat

Recovered from the befailproof.ai web platform (PR #374) session. Axis values verified against the final iteration (earlier passes: wght 413/414, ELSH 51.4). The exact --title-scale application and fallback stack are reconstructed from the session.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Introduced "Bitcount Prop Single" font template with tunable CSS variables for title typography (scale, spacing, tracking), Next.js integration examples, and self-hosting support.
  • Documentation

    • Added setup guide, usage instructions, and interactive preview page for the new font template.

Review Change Stack

Reusable title/wordmark treatment recovered from the web platform: a next/font/google loader (fonts.ts.example) plus framework-agnostic bitcount.css (.bitcount-title class, tunable knobs, self-host @font-face). Fine-tuned instance wght 417 / ELSH 55, scaleX 0.9, 0.08em tracking, lowercase. Shipped under templates/ with a .ts.example extension so repo tsc/eslint skip it.

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

coderabbitai Bot commented May 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a3bac10a-3874-497a-8163-70db8362aaa2

📥 Commits

Reviewing files that changed from the base of the PR and between cb9cc5f and 8acb241.

📒 Files selected for processing (1)
  • templates/bitcount-font/preview.html
🚧 Files skipped from review as they are similar to previous changes (1)
  • templates/bitcount-font/preview.html

📝 Walkthrough

Walkthrough

Adds a Bitcount Prop Single font template: self-hostable CSS with tuning variables and .bitcount-title, a Next.js fonts.ts example, README integration instructions, an HTML preview, and a CHANGELOG entry for v0.0.11-beta.3.

Changes

Bitcount Font Template

Layer / File(s) Summary
Bitcount variable font stylesheet
templates/bitcount-font/bitcount.css
Defines loading approaches and a self-hosted @font-face, sets :root CSS variables (--font-bitcount, --font-display, --title-scale, --title-squish, --title-tracking), and adds .bitcount-title applying fixed font-variation-settings, tracking, lowercase, and horizontal scaling.
Next.js integration and usage documentation
templates/bitcount-font/fonts.ts.example, templates/bitcount-font/README.md
fonts.ts.example exports a bitcount Next.js font loader configured with axes: ['ELSH'], variable: '--font-bitcount', and display: 'swap'. README.md documents files, Next.js/non-Next.js usage, self-hosting, tuning variables, and provenance of axis values.
Preview and release notes
templates/bitcount-font/preview.html, CHANGELOG.md
Adds preview.html demonstrating .bitcount-title headings and viewport info, and updates CHANGELOG.md with a Docs entry for 0.0.11-beta.3 announcing the template.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I found a font tucked in the grass,
A variable gem with knobs to pass,
CSS roots and a Next.js cue,
Preview bright — the headings new,
Hop in, style — and off we dash!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is comprehensive and well-structured, but does not follow the template sections (Type of Change, Checklist). It includes contents, fine-tuned instance details, verification, and provenance, providing substantial context for the font template addition. Consider adding the Type of Change checkbox (Documentation) and Checklist section from the template to fully comply with the repository's description format requirements.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a reusable Bitcount Prop Single font template from befailproof.ai, which is directly supported by all the files added to templates/bitcount-font/.
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.


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

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

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
templates/bitcount-font/README.md (1)

25-34: ⚡ Quick win

Add blank line before the table.

The table at line 26 should be surrounded by blank lines per Markdown best practices.

📝 Proposed fix
 ## Tuning knobs (`:root` in `bitcount.css`)
+
 | Variable | Default | Effect |
 |---|---|---|

As per coding guidelines (implied by static analysis): Tables should be surrounded by blank lines for proper Markdown rendering.

🤖 Prompt for 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.

In `@templates/bitcount-font/README.md` around lines 25 - 34, The Markdown table
starting at the line with header "| Variable | Default | Effect |" must be
surrounded by blank lines; edit the README content so there's an empty line
before that table (i.e., between the "## Tuning knobs (`:root` in
`bitcount.css`)" heading and the "| Variable | Default | Effect |" row) and an
empty line after the table (i.e., before the "To re-tune the glyph shape
itself..." paragraph), leaving the table contents and the `:root` /
`.bitcount-title` references unchanged.
🤖 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.

Nitpick comments:
In `@templates/bitcount-font/README.md`:
- Around line 25-34: The Markdown table starting at the line with header "|
Variable | Default | Effect |" must be surrounded by blank lines; edit the
README content so there's an empty line before that table (i.e., between the "##
Tuning knobs (`:root` in `bitcount.css`)" heading and the "| Variable | Default
| Effect |" row) and an empty line after the table (i.e., before the "To re-tune
the glyph shape itself..." paragraph), leaving the table contents and the
`:root` / `.bitcount-title` references unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dde05fec-7b24-48b5-ac21-7618539f089d

📥 Commits

Reviewing files that changed from the base of the PR and between 780a28d and 3011736.

📒 Files selected for processing (4)
  • CHANGELOG.md
  • templates/bitcount-font/README.md
  • templates/bitcount-font/bitcount.css
  • templates/bitcount-font/fonts.ts.example

Self-contained demo page (loads the font via the validated Google Fonts CDN URL + the artifact's bitcount.css) showing the .bitcount-title treatment at fluid sizes. Verified rendering across 320/375/768/1280/1920px viewports with a headless browser. Also fills in the verified CDN @import URL note in bitcount.css.

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

@coderabbitai coderabbitai Bot left a comment

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 `@templates/bitcount-font/preview.html`:
- Around line 54-57: Replace the non-semantic demo text blocks with real heading
elements: change the elements that currently use the classes "hero
bitcount-title", "h1 bitcount-title", "h2 bitcount-title", and "h3
bitcount-title" from generic <div>/<span> to semantic <h1>, <h2>, <h3> (use <h1>
for the hero/wordmark if appropriate) while preserving the existing classes and
label wrapper structure so styling/JS keeps working; apply the same change to
the similar instances mentioned (lines 62-64).
🪄 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

Run ID: 606d2c16-f144-421f-abdc-1f0143c1390d

📥 Commits

Reviewing files that changed from the base of the PR and between 3011736 and cb9cc5f.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • templates/bitcount-font/bitcount.css
  • templates/bitcount-font/preview.html
✅ Files skipped from review due to trivial changes (1)
  • CHANGELOG.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • templates/bitcount-font/bitcount.css

Comment thread templates/bitcount-font/preview.html Outdated
Address CodeRabbit a11y feedback on PR #390: the demo's heading-styled text used <div>/<span>; switch to real <h1>-<h4> in <section> wrappers (classes preserved). Add a .stack heading reset (margin:0; font-weight:inherit) so the size classes + .bitcount-title still drive rendering — verified identical layout at 375 and 1280px.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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