feat: add shortDescriptionFacets to collection

[holkexyz]

Summary

• Added optional shortDescriptionFacets array to collection for rich text annotations on shortDescription.
• Updated shortDescription description to reference the new facets field.

Why

The activity and attachment schemas already support rich text facets on their short descriptions, but collection was missing this capability. Facets enable inline mentions (@user), clickable URLs, and hashtags within the short summary text — the same pattern used throughout AT Protocol (e.g., app.bsky.feed.post). Without facets, short descriptions are limited to plain text, which is inconsistent with other record types and limits the expressiveness of collection summaries.

Test plan

• npm run check passes
• Generated types include shortDescriptionFacets on collection

🤖 Generated with Claude Code

Summary by CodeRabbit

• New Features

  • Collections now support rich text annotations on short descriptions. This enhancement enables improved text formatting, styling, and more expressive content presentation, providing developers greater flexibility in how collection descriptions are presented and formatted.

• Documentation

  • Updated collection schema documentation to document the new rich text annotation field and its capabilities for enhancing collection descriptions.

[changeset-bot]

🦋 Changeset detected

Latest commit: 8eeb304

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@hypercerts-org/lexicon	Minor

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

[coderabbitai]

Warning

Rate limit exceeded

@aspiers has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 48 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 2 minutes and 48 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a42fd23c-e12a-4ea3-a3cd-cb184fe5f03e

📥 Commits

Reviewing files that changed from the base of the PR and between a60b3c9 and 8eeb304.

📒 Files selected for processing (3)

• .changeset/collection-short-description-facets.md
• SCHEMAS.md
• lexicons/org/hypercerts/collection.json

📝 Walkthrough

Walkthrough

A new changeset entry documents the addition of a shortDescriptionFacets field to the collection lexicon. The schema update introduces this field as an array of richtext facet references, enabling rich text annotations on collection shortDescriptions.

Changes

Cohort / File(s)	Summary
Changeset Entry .changeset/collection-short-description-facets.md	Adds minor version bump entry for @hypercerts-org/lexicon documenting the new shortDescriptionFacets field addition.
Lexicon Schema lexicons/org/hypercerts/collection.json	Adds new shortDescriptionFacets field (array of richtext facet refs) and updates shortDescription field description to reference the new facets field.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

• update measurement schema #120: Introduces the same shortDescriptionFacets field to the collection lexicon for rich-text facet annotations.

Suggested reviewers

• s-adamantine

Poem

🐰 A facet here, a facet there,
Rich text blooms with thoughtful care,
Short descriptions now can shine,
With annotations so divine!
✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: add shortDescriptionFacets to collection' clearly and specifically describes the main change: adding a new optional field to the collection schema.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Lexicon Documentation Sync	✅ Passed	The PR adds shortDescriptionFacets field to collection schema, which is a facet field that may be omitted from README.md per custom check rules.
Lexicons Styleguide Compliance	✅ Passed	The PR fully complies with AT Protocol lexicon style guide standards as enforced by the repository's check-lexicon-style.js validator. The shortDescriptionFacets field adheres to all requirements including proper camelCase naming, descriptive explanation, correct typing, optional marking, and consistency with established patterns.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/collection-short-description-facets

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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