Skip to content

[ISSUE-186][docs] Adjust the README title size and add emphasis to the official website and Discord entry points.#187

Open
RocMarshal wants to merge 1 commit into
RL-Align:mainfrom
RocMarshal:ISSUE-186
Open

[ISSUE-186][docs] Adjust the README title size and add emphasis to the official website and Discord entry points.#187
RocMarshal wants to merge 1 commit into
RL-Align:mainfrom
RocMarshal:ISSUE-186

Conversation

@RocMarshal

@RocMarshal RocMarshal commented Jun 23, 2026

Copy link
Copy Markdown

close #186

Summary by CodeRabbit

  • Documentation
    • Restructured README layout with improved organization and visual hierarchy for better clarity and navigation.
    • Added dedicated Support and Documentation sections to enhance visibility of project resources.
    • Refined heading levels, spacing, and formatting throughout for improved readability and user experience.
    • Reordered top badges for better prominence of key project indicators.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@RocMarshal, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 44 minutes and 50 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 641d0f7b-9510-47a2-a05d-d84ab6fd8685

📥 Commits

Reviewing files that changed from the base of the PR and between 64de093 and e9a4cc1.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

README.md is restructured: badges are reordered in the header, heading levels are adjusted and markdown horizontal-rule separators are removed throughout, and new "Support" and "Documentation" sections are inserted before "Acknowledgments." The "Contributions" section heading and text placement are also updated.

Changes

README Restructure

Layer / File(s) Summary
Badge reorder, heading levels, separator removal, and new sections
README.md
Badges in the header are reordered; heading levels for "Performance Benchmarks," "Key Features," "Architecture," "Contributions," and "Acknowledgments" are changed; markdown horizontal-rule separators are removed; and new "Support" and "Documentation" sections are inserted before "Acknowledgments."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit rearranged the signs on the gate,
Swapped the badges and tidied each heading's weight,
Removed the dividers that cluttered the hall,
Hung "Support" and "Docs" proudly upon the wall —
Now the warren looks neat, not too early, not late! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main changes: adjusting README title sizes and adding emphasis to website and Discord entry points, which aligns with the file modifications.
Linked Issues check ✅ Passed The PR changes match the objectives in Issue #186: README title size adjustments and emphasis on official website/Discord entry points are documented modifications.
Out of Scope Changes check ✅ Passed All changes are scoped to README.md documentation modifications directly addressing the linked issue objectives; no unrelated or out-of-scope code changes are present.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

…e official website and Discord entry points.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 `@README.md`:
- Line 25: The heading "### 1. Logprob Computation (Training Stability)" uses a
level 3 heading marker (###) that skips a hierarchical level relative to the
surrounding section structure in the README, violating markdown linting rules.
Change the heading marker from ### to ## to align with the document's heading
hierarchy and ensure consistency with adjacent sections, or add the missing
intermediate heading level to maintain proper markdown structure.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: a01c20a5-17aa-4947-86d2-140115ddcac1

📥 Commits

Reviewing files that changed from the base of the PR and between acda150 and 64de093.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
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.

[docs] Adjust the README title size and add emphasis to the official website and Discord entry points.

1 participant