chore(sdk-core): enhance RichText changeset with versioning note and usage examples

[aspiers]

Summary

• Adds a 0.x versioning note clarifying this is a non-breaking addition
• Corrects the description of unresolved mention handling (handle string used as DID, not left unresolved)
• Adds usage examples for both createFacetsFromText and createFacetsFromTextSync

Details

This cherry-picks a single commit (c175665) from the banner branch that improves the add-richtext-utility.md changeset documentation. It is entirely unrelated to the DID validation and blob ref changes on that branch and can be merged independently.

Only .changeset/add-richtext-utility.md is modified — no source code changes.

Extracted from #123.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a2b7074

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

[coderabbitai]

Warning

Rate limit exceeded

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

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

📝 Walkthrough

Walkthrough

A changeset update clarifies the public API documentation for rich text facet creation functions, explicitly documenting mention resolution behavior based on whether an agent is provided, with no functional changes to the implementation.

Changes

Cohort / File(s)	Summary
API Documentation Clarification .changeset/add-richtext-utility.md	Clarified public API documentation for createFacetsFromText() and createFacetsFromTextSync() to explicitly document mention resolution behavior: agent-dependent resolution for async variant, handle-based fallback for sync variant, and noted re-export of RichText class.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A clarified contract, no secrets to hide,
Rich text flows onward, with mentions nationwide,
Async resolves with an agent's fine hand,
Sync takes the shortcut across the great land,
Documentation blooms, the API stands grand! 📜✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title accurately describes the main change: enhancing a RichText changeset with versioning notes and usage examples, which matches the modifications to .changeset/add-richtext-utility.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch richtext-changeset

---

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

[Copilot]

Pull request overview

This PR enhances the changeset documentation for the RichText utility functions by adding clarifications and usage examples. The changes improve the developer experience by providing better context about versioning, mention handling behavior, and practical code examples.

Changes:

• Adds a 0.x versioning note clarifying this is a non-breaking addition
• Corrects the description of unresolved mention handling to accurately state that the handle string is used as the DID
• Adds TypeScript usage examples demonstrating both sync and async function usage

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.changeset/add-richtext-utility.md:
- Around line 19-27: The code block declares const facets twice causing a
redeclaration error; change the duplicate variable names so each call uses a
unique identifier (e.g., rename the result of createFacetsFromTextSync(...) to
facetsSync and the result of await createFacetsFromText(...) to facetsAsync) and
ensure the async example stays in an async context when using await; update
references accordingly for createFacetsFromTextSync and createFacetsFromText.