Skip to content

docs: rewrite README to be more inviting - #633

Merged
jeffreylouden merged 1 commit into
mainfrom
claude/catalogs-readme-improve-p35j5s
Aug 20, 2026
Merged

docs: rewrite README to be more inviting#633
jeffreylouden merged 1 commit into
mainfrom
claude/catalogs-readme-improve-p35j5s

Conversation

@jeffreylouden

Copy link
Copy Markdown
Member

Description

Full rewrite of the README to make the project more inviting to contributors and data consumers, and to fix content that had drifted from reality:

  • Fixed stale examples: the manufacturer example showed a slug: field that no longer exists (slugs come from filenames), the data-structure tree omitted the content/ and accessories/ collections, and one SQL example queried software_formats by a slug ('serum') when IDs are nanoids. Examples now mirror real entries (xfer-records-serum.yaml, universal-audio-apollo-twin-x.yaml) including the <manufacturer-slug>-<product-slug>.yaml filename convention and a hardware io snippet.
  • New badges: latest release version, OpenSSF Scorecard (the workflow publishes results, so the badge resolves), and PRs-welcome, alongside the existing Validate/Release/license badges. License badges now link to the in-repo license files.
  • More inviting framing: leads with what the catalog is and its scale (12,000+ products, 4,000+ manufacturers, per-collection counts table), a "Why this exists" section, and a contributor pitch that points at pnpm validate and docs/VALIDATION_ERRORS.md as the safety net.
  • Documented the release artifacts: checksum verification snippet, minisign signature, SBOM, and an accurate description of the Changesets-driven release flow (the previous draft claimed every push to main cuts a release, which is not how release.yml works).
  • Aureo is mentioned as the app the catalog powers, without turning the README into a promo, and the CC0 data license is framed as an invitation to build on it.

Type of Change

  • New software/plugin entry
  • New hardware entry
  • New manufacturer entry
  • Update to existing entry
  • Bug fix
  • Schema or script change

Checklist

  • I have run pnpm validate and it passes (no data files touched)
  • YAML files follow the existing format (examples mirror real entries)
  • Manufacturer exists (or I'm adding it in this PR) — n/a, docs only
  • Categories and formats are from the schema files (examples use real values)
  • Identifiers are accurate, if provided (copied from xfer-records-serum.yaml)

Additional Notes

Docs-only change, no data or script edits. All counts, table names in the SQL examples, and release-asset names were verified against the current data/ tree, scripts/schema.sql, and release.yml.

🤖 Generated with Claude Code

https://claude.ai/code/session_01GmHrQEQmpYthrHhmV2cB2c


Generated by Claude Code

Fix stale examples (removed slug field, missing
collections, slug-keyed SQL), add release and
scorecard badges, document download verification
and the changesets release flow.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GmHrQEQmpYthrHhmV2cB2c
@changeset-bot

changeset-bot Bot commented Aug 20, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4f79ba2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added the documentation Documentation updates label Aug 20, 2026
@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your current included review allowance is based on your included PR review attempts over the past 7 days.

Next review available in: 6 minutes

Limit details: You’ve used the included review currently available. Your 105 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

You’re in a promotional period — use the checkbox below to run this review for free:

  • Run review for free

On-demand reviews are free for the next 31 days. After that, they cost $0.25 per reviewed file.

How can I continue?

Run this review now using the option above, or comment @coderabbitai review --use-credits.

You can also wait for the limit to reset, then comment @coderabbitai review or push new commits to the PR.

An organization admin can change what happens after included review limits in Billing.

How do review limits work?

CodeRabbit enforces per-developer PR review limits within each organization.

For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 346c0869-4341-4f8b-8eee-c015543e9a74

📥 Commits

Reviewing files that changed from the base of the PR and between e3d6273 and 4f79ba2.

📒 Files selected for processing (1)
  • README.md

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

@jeffreylouden
jeffreylouden merged commit 1d35bbc into main Aug 20, 2026
7 checks passed
@jeffreylouden
jeffreylouden deleted the claude/catalogs-readme-improve-p35j5s branch August 20, 2026 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants