docs: improve grammar and brand consistency across docs#26
Conversation
WalkthroughText-only documentation updates: branding references standardized to “Allonsh.js” in CONTRIBUTING.MD and grammar plus selector-usage clarifications added to docs/allonsh.md. No code, APIs, or behavior changed. Changes
Sequence Diagram(s)(No sequence diagrams generated — changes are documentation-only and do not affect control flow or runtime interactions.) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Cache: Disabled due to data retention organization setting Knowledge Base: Disabled due to data retention organization setting 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/allonsh.md (1)
1-1: Brand consistency: consider “Allonsh.js Docs”.Title currently says “Allonsh Docs.” To fully meet the PR objective (“use ‘Allonsh.js’ consistently”), consider updating to “Allonsh.js Docs.” This keeps prose branding consistent while the import/package name remains
allonshin code examples.
🧹 Nitpick comments (2)
docs/allonsh.md (2)
19-19: Clarify snap-back timing to match Behavior section.This phrasing could imply the element returns while dragging. Behavior section (Line 73) states it snaps back when dropped outside any dropzone. Suggest aligning the sentence:
- - `restrictToDropzones` (boolean, optional) — If `true`, dragging outside dropzones will return the element to its origin. Default: `false`. + - `restrictToDropzones` (boolean, optional) — If `true`, elements snap back to their origin if dropped outside any dropzone. Default: `false`.
25-26: Tighten wording and code-formatting for selector note.Add code formatting for option names and examples; clarify “class names, not CSS selectors”:
-**Note:** The draggableSelector, dropzoneSelector, and playAreaSelector parameters expect class names without the leading '.' For example, if the class name is .draggable, pass draggable (without the dot). +**Note:** The `draggableSelector`, `dropzoneSelector`, and `playAreaSelector` options expect class names, not CSS selectors (omit the leading '.'). +For example, if the class is `.draggable`, pass `'draggable'` (without the dot).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
CONTRIBUTING.MD(2 hunks)docs/allonsh.md(1 hunks)
🔇 Additional comments (3)
CONTRIBUTING.MD (3)
1-1: Branding header capitalization looks good.Header updated to “Allonsh.js” aligns with the PR objective. No further action here.
3-3: Intro sentence reads well and matches brand usage.Clear, friendly tone and correct “Allonsh.js” branding.
86-86: Closing line matches brand and tone.Consistent with header and objective.
Description
Related Issue
Type of Change
How Has This Been Tested?
Using
npm run testand local server.Checklist
Additional Notes
N/A
Summary by CodeRabbit