Bring back "type" in the collections

[s-adamantine]

Changes:

• Added optional type field to specify collection type (e.g., 'favorites', 'project')
• Changed collectionDescription from string to Leaflet linear document reference (pub.leaflet.pages.linearDocument#main) to support rich-text descriptions

Reasoning:

• the collections lexicon and the projects lexicon are very similar, and the only thing that differentiates between the two are the type.

Summary by CodeRabbit

• New Features

  • Added an optional collection "type" for categorization (e.g., "favorites", "project").
  • Collection descriptions now support rich-text Leaflet documents for fuller detail views.
  • Descriptive fields renamed for clearer, consistent naming (title, shortDescription, description).

• Breaking Changes

  • The collection description now expects a referenced rich-text document instead of plain text.

• Documentation

  • Examples and docs updated to reflect renamed fields and rich-text description usage.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[changeset-bot]

🦋 Changeset detected

Latest commit: 091842a

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]

📝 Walkthrough

Walkthrough

Updates the org.hypercerts.claim.collection lexicon: adds an optional type field, renames collectionTitle→title and shortCollectionDescription→shortDescription, and replaces collectionDescription (string) with description as a pub.leaflet.pages.linearDocument#main reference. Changeset, ERD, and README examples updated.

Changes

Cohort / File(s)	Summary
Lexicon Schema lexicons/org/hypercerts/claim/collection.json	Added optional type (string). Renamed collectionTitle → title and shortCollectionDescription → shortDescription. Replaced collectionDescription (string) with description as a ref to pub.leaflet.pages.linearDocument#main (rich-text). Updated required properties.
Documentation & Examples README.md	Updated examples and documentation to use title, shortDescription, and description (Leaflet ref) and to reflect the new type field and renamed properties.
Changeset .changeset/update-collection-lexicon.md	Bumped package minor version and documented the schema edits and breaking change (description now expects a Leaflet linearDocument ref).
ER Diagram ERD.puml	Updated collection class: added optional type, added title, renamed shortDescription, and replaced collectionDescription? with description? (Leaflet ref).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Project as collection sidecar #78: Directly modifies the same org.hypercerts.claim.collection fields (title/shortDescription/description/type) and appears to overlap schema edits.
• Unify project and collection schemas #75: Adds type and adjusts collection description/name fields to Leaflet refs in the same lexicon.
• Lexicon review #23: Contains related refactor of collection schema and ERD updates matching these renames and description ref changes.

Suggested reviewers

• bitbeckers

Poem

🐇 I hopped through schemas, changed a name or two,
Titles now tidy and short previews too,
Descriptions grew roots in Leaflet's bright land,
A type tucked in softly by a careful paw and hand,
Hooray — this rabbit approves the new view!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Lexicons Styleguide Compliance	⚠️ Warning	The lexicon file generally follows ATProto styleguide conventions but violates requirements by omitting maxLength and maxGraphemes constraints on the type field.	Add maxLength and maxGraphemes constraints to the type field and document breaking changes within the lexicon file itself.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Bring back "type" in the collections' directly reflects the primary change: re-adding an optional type field to the collection entity, which is the key distinguishing feature mentioned in the PR objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Lexicon Documentation Sync	✅ Passed	The pull request successfully maintains synchronization between the JSON lexicon, README.md, and ERD.puml with all schema changes consistently reflected.

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

---

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.}