Skip to content

fix: readme - #19

Merged
elkaix merged 1 commit into
mainfrom
fix/readme
Aug 14, 2026
Merged

fix: readme#19
elkaix merged 1 commit into
mainfrom
fix/readme

Conversation

@elkaix

@elkaix elkaix commented Aug 14, 2026

Copy link
Copy Markdown
Member

Add prominent install command at top and hidden visitor counter at bottom of README.

@elkaix
elkaix merged commit d794b72 into main Aug 14, 2026
@elkaix
elkaix deleted the fix/readme branch August 14, 2026 06:19
@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@elkaix, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 40 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

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

How do review limits work?

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

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c27eec8c-6160-4455-9862-3a958192addc

📥 Commits

Reviewing files that changed from the base of the PR and between 89d9d87 and d6491c7.

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

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

@greptile-apps

greptile-apps Bot commented Aug 14, 2026

Copy link
Copy Markdown

Greptile Summary

The README adds a prominent installation command near the top and a visitor counter. The new heading collides with the existing installation heading’s generated anchor, so #install links now open the abbreviated command rather than the complete setup section with requirements, timeout guidance, and follow-up configuration. Rename the new heading to give it a distinct anchor before merging.

Confidence Score: 4/5

The documentation change should not be merged until the duplicate installation anchor is resolved, because existing links no longer lead readers to the complete setup instructions.

A focused execution check reproduced one independent, non-security documentation navigation failure and directly verified the generated anchors and their destinations.

Files Needing Attention: README.md needs its top installation heading renamed or otherwise given a unique anchor.

T-Rex T-Rex Logs

What T-Rex did

  • T-Rex produced a proof for a posted P2 finding and attached supporting artifacts, including an Install-anchor validation script.
  • T-Rex captured the heading normalization output before duplicate anchor disambiguation and the rendered anchor resolution output after disambiguation in logs.
  • The contract-validation proof documented exact observed evidence showing that the Install anchor maps from line 28 to the install id, corroborating the behavior described in the finding.
  • The contract-validation proof also confirmed the final rendered IDs are install and install-1.

View all artifacts

T-Rex Ran code and verified through T-Rex

Comments Outside Diff (1)

  1. General comment

    P2 Install links resolve to the abbreviated command instead of the detailed installation section

    • Bug
      • The navigation link at README line 20 and the inline Install link at line 215 target #install, which resolves to the first heading at line 28 rather than the detailed Install section at line 148.
    • Cause
      • Both headings normalize to the same GitHub-style base ID install; duplicate disambiguation preserves install for the first heading and gives the later heading install-1.
    • Fix
      • Give one heading distinct text/anchor semantics and update links intended for the detailed section to its resulting unique anchor, or use an explicit unique heading anchor supported by the rendering environment.

    T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "fix: readme" | Re-trigger Greptile

Comment thread README.md
<a href="#configuration"><b>Configuration</b></a>
</p>

# ⚡ Install

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Duplicate install anchor

Both installation headings normalize to #install. GitHub assigns install to this abbreviated heading and install-1 to the detailed section at line 148, so existing #install links land here instead of the complete setup instructions. Rename this heading (for example, # ⚡ Quick Install) so #install continues to target the detailed installation section.

Artifacts

Focused README Install-anchor validation script

  • Dependency-free Node script executed against README.md to normalize headings and resolve duplicate GitHub-style anchors; it demonstrates the detailed section receives install-1.

Heading normalization output before duplicate anchor disambiguation

  • Captured execution of the normalization phase showing both line 28 and line 148 normalize to #install, confirming the collision.

Rendered anchor resolution output after duplicate disambiguation

  • Captured execution of the resolution phase showing line 28 receives install and both #install links target it, confirming the detailed section is skipped.

View artifacts

T-Rex Ran code and verified through T-Rex

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.

1 participant