Skip to content

Update README to match the current build and hosting setup - #538

Open
fzipi wants to merge 1 commit into
mainfrom
docs/readme-update
Open

Update README to match the current build and hosting setup#538
fzipi wants to merge 1 commit into
mainfrom
docs/readme-update

Conversation

@fzipi

@fzipi fzipi commented Aug 17, 2026

Copy link
Copy Markdown
Member

The README had drifted from the repository. Corrections:

  • Hugo version: said >= 0.123.0; package.json pins hugo-extended ^0.163.0 and .github/workflows/test.yml builds with 0.163.1.
  • Installing Hugo: npm install provides Hugo extended via the hugo-extended package, so a system-wide install is optional. This was not mentioned.
  • Build commands: documented hugo serve only. Added a table of the npm scripts that exist, including dev:start:with-pagefind, which is the only way site search works locally.
  • Hosting: said merges are pushed to coreruleset.github.io/website/ for preview. The site runs on Cloudflare Pages, with per-PR preview deployments; the old link was also missing its scheme, so it rendered as a relative path.
  • Additions: Node version pinned in .tool-versions, the devcontainer, the separate hugo -s subsite/docs build that CI merges into public/docs, and what the test workflow checks.
  • Badge label read "Check Links"; the workflow builds the sites and runs the link check.

Stale npm output (package counts from an old npm install) was dropped.

🤖 Generated with Claude Code

- Hugo extended >= 0.163.0, installed via the hugo-extended npm package
- Document the npm scripts, including the Pagefind variant for local search
- Note the pinned Node version, the devcontainer, and the separate docs build
- Replace the coreruleset.github.io preview note with Cloudflare Pages

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

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

Next review available in: 2 minutes

Limit details: You’ve used all 1 included review currently available under your plan.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fc99ced3-f928-4ddf-8084-dc0ec773f598

📥 Commits

Reviewing files that changed from the base of the PR and between 24a6d14 and 7ddfc49.

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

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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7ddfc49
Status: ✅  Deploy successful!
Preview URL: https://83aa7fa6.website-1u6.pages.dev
Branch Preview URL: https://docs-readme-update.website-1u6.pages.dev

View logs

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