docs: rewrite README to be more inviting - #633
Conversation
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
|
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. 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:
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 You can also wait for the limit to reset, then comment 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 configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Comment |
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:
slug:field that no longer exists (slugs come from filenames), the data-structure tree omitted thecontent/andaccessories/collections, and one SQL example queriedsoftware_formatsby 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>.yamlfilename convention and a hardwareiosnippet.pnpm validateanddocs/VALIDATION_ERRORS.mdas the safety net.maincuts a release, which is not howrelease.ymlworks).Type of Change
Checklist
pnpm validateand it passes (no data files touched)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, andrelease.yml.🤖 Generated with Claude Code
https://claude.ai/code/session_01GmHrQEQmpYthrHhmV2cB2c
Generated by Claude Code