Grammar Changes, Added links, etc etc#51
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Import callout
WalkthroughDocumentation updates across command and feature pages: added callouts, refined wording, adjusted capitalization, improved links/formatting, clarified examples, and expanded XP command syntax description. Voice XP docs were reorganized into stepwise bullets clarifying timing and calculation. No code or API changes; all edits are within MDX documentation. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant M as Member
participant V as Voice Channel
participant K as Kiai
note over M,V: Voice XP session lifecycle (documentation flow)
M->>V: Join voice channel
K-->>K: Wait 10s, verify still present
alt Still present after 10s
K->>K: Record join time (includes initial 10s)
rect rgba(200,230,255,0.25)
note right of K: Tracking session<br/>Mute/Deafen time excluded
end
else Left within 10s
K-->>K: Do not start session
end
M-->>V: Mute/Deafen
K-->>K: Exclude muted/deafened duration
M->>V: Leave voice channel
K-->>K: Wait 10s before finalize
K->>K: Compute XP and apply level-ups
K-->>M: XP/level updates reflected after session ends
note over K: Denylist and multiplier rules applied
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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: 1
🧹 Nitpick comments (9)
pages/commands/multiplier.mdx (1)
17-18: Align terminology: “XP” vs “points.”For clarity, consider using “XP” consistently in the example output.
Apply this diff:
-This multiplier is applied to the base amount of XP a user earns in a channel, role, or server. For example, if a user earns 3 XP from a message, and the multiplier for that message's channel is 2, the user will earn 6 points in that channel. +This multiplier is applied to the base amount of XP a user earns in a channel, role, or server. For example, if a user earns 3 XP from a message, and the multiplier for that message's channel is 2, the user will earn 6 XP in that channel.pages/commands/preferences.mdx (1)
15-15: Tighten wording and fix punctuation.Simplify phrasing, add a terminal period, and format the command inline.
Apply this diff:
-The /preferences command allows you to change the settings of Kiai that are specific to you, such as whether you should be pinged when you level up, or your personal rank background +The `/preferences` command lets you change Kiai settings specific to you, such as whether you're pinged when you level up or your personal rank background.pages/commands/rewards.mdx (1)
19-19: Switch to HTTPS for external link.
Prefer HTTPS for Unbelievaboat.Apply this diff:
-The rewards command allows you to set up rewards for your server. These rewards can be roles, messages, or money in [Unbelievaboat](http://unbelievaboat.com/). +The rewards command allows you to set up rewards for your server. These rewards can be roles, messages, or money in [Unbelievaboat](https://unbelievaboat.com/).pages/commands/xp.mdx (1)
32-32: Fix example: specify the option name for role.
Other examples use role:@members; keep consistent.Apply this diff:
-/xp set level:100 @Members +/xp set level:100 role:@Memberspages/commands/settings.mdx (2)
63-64: Minor copy tweak for clarity.
Tighten wording and avoid leading “is”.Apply this diff:
-- `{expire}`: is replaced with a Discord timestamp showing when the drop will expire. Discord automatically formats it into a relative time (e.g., “in 1 hour” or “1 hour ago”). +- `{expire}`: A Discord timestamp showing when the drop will expire. Discord automatically formats it into a relative time (e.g., "in 1 hour" or "1 hour ago").
67-67: Style nit: colon usage is good; consider adding a blank line before the code block.
Improves readability before the example.pages/index.mdx (2)
44-46: Format channel names as code for readability.Inline-code styling improves scannability for channel names.
Apply:
-We recommend denylisting utility channels like #commands or #bot-spam. +We recommend denylisting utility channels like `#commands` or `#bot-spam`.
53-53: Fix brand capitalization: “UnbelievaBoat”.Correct brand name capitalization to avoid confusion.
Apply:
-- Money in [Unbelievaboat](https://unbelievaboat.com/) +- Money in [UnbelievaBoat](https://unbelievaboat.com/)pages/commands/import.mdx (1)
49-51: Confirmed/reset xp-onlyexists; no xp-only anchor
pages/commands/reset.mdx contains the exact/reset xp-only, so the link to /commands/reset is correct — add a fragment (e.g. /commands/reset#xp-only) only if you want a direct jump.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (12)
pages/commands/application.mdx(2 hunks)pages/commands/custom-formula.mdx(1 hunks)pages/commands/import.mdx(1 hunks)pages/commands/multiplier.mdx(1 hunks)pages/commands/preferences.mdx(1 hunks)pages/commands/premium.mdx(1 hunks)pages/commands/rewards.mdx(1 hunks)pages/commands/settings.mdx(2 hunks)pages/commands/xp.mdx(2 hunks)pages/features/Voice XP.mdx(1 hunks)pages/features/custom-formulas.mdx(1 hunks)pages/index.mdx(2 hunks)
🔇 Additional comments (12)
pages/commands/multiplier.mdx (1)
18-18: Capitalization update looks good."XP" capitalization reads consistently with the rest of the docs.
pages/commands/preferences.mdx (1)
11-11: Confirm permission scope change (“available to everyone”).If the bot enforces any Discord permissions or internal gating for this command, align the doc accordingly. Otherwise, this change looks good.
pages/commands/premium.mdx (1)
15-15: LGTM — added link improves navigation.
No issues.pages/commands/application.mdx (2)
1-1: Verify Callout availability and import path for your Nextra version.
A previous review noted Callout wasn’t available. In Nextra v2, Callout is typically imported from "nextra/components", not "nextra-theme-docs". Please confirm your docs theme/version.Apply if you’re on Nextra v2:
-import { Callout } from "nextra-theme-docs"; +import { Callout } from "nextra/components";Fallback (if Callout isn’t supported): replace with a Markdown blockquote warning.
20-22: Good addition — security warning is helpful.
Once the import/version is confirmed, this content reads well.pages/commands/custom-formula.mdx (1)
19-19: LGTM — default formula wording is consistent and clear.
Matches the features page’s expression once the link fix there is applied.pages/commands/xp.mdx (1)
6-11: Syntax expansion looks good; confirm commands are live.
Prune/reset/set additions read well; ensure these subcommands are available in the bot slash commands to avoid user confusion.pages/features/Voice XP.mdx (2)
3-8: LGTM — clearer wording and helpful link to settings.
No issues.
11-16: LGTM — stepwise flow clarifies timing and calculation.
The post-leave calculation note is especially useful.pages/index.mdx (3)
31-31: LGTM: Consistent inline command link.
35-35: LGTM: Import command reference reads clearly and matches style.
54-54: LGTM: Wording is clear and consistent with the section.
2 participants
Summary by CodeRabbit