Create README.mds for each package, expand on docs#23
Merged
Conversation
🦋 Changeset detectedLatest commit: ba51e2f The changes in this PR will be included in the next version bump. This PR includes changesets to release 10 packages
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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
package: core
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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 configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (29)
WalkthroughThis PR adds comprehensive documentation across the SayKit monorepo, including package READMEs, website documentation covering core concepts and guides, complete API references, and integration documentation. A small runtime fix addresses locale prefix matching in the ChangesDocumentation overhaul and runtime fix
🎯 2 (Simple) | ⏱️ ~12 minutes Suggested labels
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 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/integration-carbon/README.md`:
- Around line 16-22: The example usage references the Say type but does not
import it; update the top import line that currently imports Client, Command,
and CommandInteraction from '`@buape/carbon`' (and/or imports from
'`@saykit/carbon`' like SayPlugin/withSay) to also import the Say type (e.g., add
a type import for Say or include Say in the import list) so the PingCommand
constructor signature (constructor(say: Say)) compiles when copy-pasted.
In `@packages/transform-js/README.md`:
- Around line 22-26: The example shows using jsx() but misses its import; update
the README's transformer snippet to include an import for jsx from
"`@saykit/transform-jsx`" alongside the existing js import so the example is
valid—ensure the top of the example imports both js and jsx (referencing the
js() and jsx() symbols) and then use transformer: [js(), jsx()] in the sample.
In `@packages/transform-jsx/README.md`:
- Line 20: The usage example for the configuration object incorrectly ends the
transformer array line with a semicolon; change the line containing
"transformer: [js(), jsx()];" to use a comma instead so the property correctly
terminates within the bucket config object (update the "transformer" property
that references js() and jsx() to end with a comma).
In `@website/content/reference/cli.mdx`:
- Line 101: The phrase "The most common CI check is: extraction has been run,
and translations are up to date with code:" uses "up to date" as an adjectival
modifier—replace "up to date" with the hyphenated form "up-to-date" so it reads
"...translations are up-to-date with code:" to keep adjectival consistency;
update the string in the content where that exact sentence appears.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1239cf57-4fde-472b-81a9-05e2d60339cf
📒 Files selected for processing (41)
README.mdpackages/config/README.mdpackages/format-po/README.mdpackages/integration-carbon/README.mdpackages/integration-react/README.mdpackages/integration/README.mdpackages/integration/src/runtime.tspackages/plugin-babel/README.mdpackages/plugin-unplugin/README.mdpackages/transform-js/README.mdpackages/transform-jsx/README.mdwebsite/app/(home)/page.tsxwebsite/content/core-concepts/architecture.mdxwebsite/content/core-concepts/configuration.mdxwebsite/content/core-concepts/extraction.mdxwebsite/content/core-concepts/formats.mdxwebsite/content/core-concepts/messages.mdxwebsite/content/core-concepts/meta.jsonwebsite/content/core-concepts/runtime.mdxwebsite/content/getting-started/installation.mdxwebsite/content/getting-started/introduction.mdxwebsite/content/getting-started/quickstart.mdxwebsite/content/guides/custom-formatter.mdxwebsite/content/guides/custom-transformer.mdxwebsite/content/guides/dynamic-loading.mdxwebsite/content/guides/locale-detection.mdxwebsite/content/guides/meta.jsonwebsite/content/guides/typed-messages.mdxwebsite/content/integrations/babel.mdxwebsite/content/integrations/carbon.mdxwebsite/content/integrations/meta.jsonwebsite/content/integrations/react.mdxwebsite/content/integrations/vite.mdxwebsite/content/meta.jsonwebsite/content/reference/api/carbon.mdxwebsite/content/reference/api/config.mdxwebsite/content/reference/api/meta.jsonwebsite/content/reference/api/react.mdxwebsite/content/reference/api/saykit.mdxwebsite/content/reference/cli.mdxwebsite/content/reference/meta.json
github-actions
Bot
added
dependencies
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #10
Summary by CodeRabbit
Release Notes
Documentation
Bug Fixes