docs: add missing descriptions to contributor and item defs - #177
Conversation
🦋 Changeset detectedLatest commit: 07bd5fe The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (4)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR adds human-readable Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
3400869 to
4364c6e
Compare
s-adamantine
left a comment
There was a problem hiding this comment.
We agreed during the call to add in missing descriptions, and this is a non-breaking change.
There is also a small change in the schema generation to update the schema markdown file. Now the markdown files also display the descriptions.
|
I ran another AI to check if there were missing descriptions elsewhere, and it didn't find any. LGTM. |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The generate-schemas script was not outputting the description field from def objects. This meant adding descriptions to defs in lexicon JSON had no visible effect in SCHEMAS.md.
1c1e13e to
07bd5fe
Compare
Summary
descriptionto thecontributordef onactivityand theitemdef oncollection.Why
The lexicon style checker flags object defs without descriptions. More importantly, these descriptions appear in generated documentation and code comments, helping developers understand the purpose of each type without reading the full schema. The
contributoranditemdefs were the only object types in the protocol missing descriptions.Test plan
npm run checkpasses🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores