Skip to content

docs: improve grammar and brand consistency across docs#26

Merged
satnam72 merged 2 commits intomainfrom
docs/fix-grammer-improve-brand-consistency
Aug 25, 2025
Merged

docs: improve grammar and brand consistency across docs#26
satnam72 merged 2 commits intomainfrom
docs/fix-grammer-improve-brand-consistency

Conversation

@satnam72
Copy link
Owner

@satnam72 satnam72 commented Aug 25, 2025

Description

  • Fix grammar and improve the branding across the docs.

Related Issue

Type of Change

  • Documentation update

How Has This Been Tested?

Using npm run test and local server.

Checklist

  • My code follows the project’s style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Additional Notes

N/A

Summary by CodeRabbit

  • Documentation
    • Updated branding capitalization from “allonsh.js” to “Allonsh.js.”
    • Reworded restrictToDropzones description for clarity (no behavior change).
    • Added a note clarifying selector options (draggableSelector, dropzoneSelector, playAreaSelector) expect class names without a leading dot, with an example.
    • General wording and readability improvements across docs; no functional or API changes.

@coderabbitai
Copy link

coderabbitai bot commented Aug 25, 2025

Walkthrough

Text-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

Cohort / File(s) Summary
Branding consistency
CONTRIBUTING.MD
Updated occurrences of “allonsh.js” to “Allonsh.js” in header, intro, and closing line.
Docs grammar and usage notes
docs/allonsh.md
Fixed phrasing for restrictToDropzones description and added note clarifying that selector options expect class names without a leading dot, with example.

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

Objective Addressed Explanation
Fix grammar in docs/allonsh.md (“return element to origin” → “return the element to its origin”) [#24]
Clarify that selectors expect class names without leading '.' in docs/allonsh.md [#24]
Brand consistency across all documentation (“Allonsh.js” consistently) [#24] Only CONTRIBUTING.MD and docs/allonsh.md shown updated; other documentation files not present to verify.
Update CONTRIBUTING.md header branding if needed [#24]

Poem

A nibble of docs, a hop of delight,
I polished the names till they gleamed just right.
Dots off the classes, grammar in tune,
Allonsh.js sings a clearer tune!
With twitching nose I stamp approval—boop! 🐇✨

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

📥 Commits

Reviewing files that changed from the base of the PR and between d253a69 and cd7874b.

📒 Files selected for processing (1)
  • docs/allonsh.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/allonsh.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/fix-grammer-improve-brand-consistency

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@satnam72 satnam72 marked this pull request as ready for review August 25, 2025 03:02
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 allonsh in 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 06bc032 and d253a69.

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

@satnam72 satnam72 assigned satnam72 and unassigned satnam72 Aug 25, 2025
@satnam72 satnam72 merged commit 65b1f4f into main Aug 25, 2025
2 checks passed
@satnam72 satnam72 deleted the docs/fix-grammer-improve-brand-consistency branch August 27, 2025 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation clarity and brand consistency

1 participant