Skip to content

docs: improve wording and formatting consistency in FEATURES.md#39938

Open
NA-V10 wants to merge 1 commit intoRocketChat:developfrom
NA-V10:docs/features-md-cleanup
Open

docs: improve wording and formatting consistency in FEATURES.md#39938
NA-V10 wants to merge 1 commit intoRocketChat:developfrom
NA-V10:docs/features-md-cleanup

Conversation

@NA-V10
Copy link
Copy Markdown

@NA-V10 NA-V10 commented Mar 29, 2026

Proposed changes

This PR improves the wording, capitalization, and formatting consistency in FEATURES.md.

Changes include:

  • Updating inconsistent terms such as Self Host to Self-Host
  • Replacing Github with GitHub
  • Changing TexMath to TeX Math
  • Improving readability in several bullet points
  • Standardizing capitalization and formatting across the feature list

These are documentation-only changes and do not affect application behavior.

Issue(s)

N/A

Steps to test or reproduce

  • Open FEATURES.md
  • Review the updated wording and formatting changes
  • Confirm the markdown structure renders correctly

Further comments

This PR is focused on improving readability and consistency in the feature documentation to make it easier for contributors and users to scan.

Summary by CodeRabbit

  • Documentation
    • Refined feature descriptions with standardized capitalization, improved terminology consistency, and enhanced phrasing throughout the features documentation for better clarity and presentation.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 29, 2026

⚠️ No Changeset found

Latest commit: 6a83c6b

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

@dionisio-bot
Copy link
Copy Markdown
Contributor

dionisio-bot bot commented Mar 29, 2026

Looks like this PR is not ready to merge, because of the following issues:

  • This PR is missing the 'stat: QA assured' label
  • This PR is missing the required milestone or project

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 29, 2026

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2f10658a-f66c-4806-98c9-04874db173d7

📥 Commits

Reviewing files that changed from the base of the PR and between 4235cd9 and 6a83c6b.

📒 Files selected for processing (1)
  • FEATURES.md
📜 Recent review details
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 38974
File: apps/meteor/app/api/server/v1/im.ts:220-221
Timestamp: 2026-02-24T19:09:09.561Z
Learning: In RocketChat/Rocket.Chat OpenAPI migration PRs for apps/meteor/app/api/server/v1 endpoints, maintainers prefer to avoid any logic changes; style-only cleanups (like removing inline comments) may be deferred to follow-ups to keep scope tight.
Learnt from: smirk-dev
Repo: RocketChat/Rocket.Chat PR: 39625
File: apps/meteor/app/api/server/v1/push.ts:85-97
Timestamp: 2026-03-14T14:58:58.834Z
Learning: In RocketChat/Rocket.Chat, the `push.token` POST/DELETE endpoints in `apps/meteor/app/api/server/v1/push.ts` were already migrated to the chained router API pattern on `develop` prior to PR `#39625`. `cleanTokenResult` (which strips `authToken` and returns `PushTokenResult`) and `isPushTokenPOSTProps`/`isPushTokenDELETEProps` validators already exist on `develop`. PR `#39625` only migrates `push.get` and `push.info` to the chained pattern. Do not flag `cleanTokenResult` or `PushTokenResult` as newly introduced behavior-breaking changes when reviewing this PR.
🔇 Additional comments (3)
FEATURES.md (3)

3-3: Excellent consistency improvements!

The hyphenation of "Self-Host" and the capitalization normalization ("Multiple deployment options", "Desktop and mobile") improve readability and follow standard documentation conventions.

Also applies to: 5-5, 24-24


11-11: Correct brand and technical name formatting!

"GitHub" and "TeX Math" are the proper capitalizations for these names. Good attention to detail.

Also applies to: 45-45


27-27: Improved clarity and readability!

The rewording from "in your e-mail" to "by e-mail" is more concise and clearly indicates the delivery method. The restructuring of "Single-line or multi-line code" provides better parallel structure and readability compared to the previous phrasing.

Also applies to: 44-44


Walkthrough

Documentation content in FEATURES.md was updated with adjustments to phrasing, capitalization, and formatting of feature descriptions. Changes include hyphenation adjustments, capitalization corrections, and minor wording revisions. No functional logic was modified.

Changes

Cohort / File(s) Summary
Documentation Updates
FEATURES.md
Adjusted phrasing, capitalization, and formatting in feature list entries (e.g., "Self Host" → "Self-Host", "Github" → "GitHub", "Multiple Deployment Options" → "Multiple deployment options", "Desktop and Mobile" → "Desktop and mobile", notification wording, and code formatting description restructuring).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

type: chore

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: improving wording and formatting consistency in FEATURES.md, which aligns with all the documented modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@NA-V10
Copy link
Copy Markdown
Author

NA-V10 commented Mar 29, 2026

Thank you for reviewing this PR. Please let me know if any additional changes, labels, or milestone updates are needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants