docs: update README to match the current build and hosting setup - #538
Conversation
- 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>
|
Warning Review limit reached
Next review available in: 52 minutes Limit details: You’ve used the included review currently available. 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?Wait for the limit to reset, then comment An organization admin can change what happens after included review limits in Billing. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
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. Comment |
Deploying website with
|
| Latest commit: |
aedd762
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8166b819.website-1u6.pages.dev |
| Branch Preview URL: | https://docs-readme-update.website-1u6.pages.dev |
|
@coderabbitai full_review |
|
|
fzipi
changed the title
.tool-versions is not tracked in this repository and is not gitignored either, so pointing contributors at it would send them looking for a file that is not there. There is also no committed Node version pin to redirect the sentence to: package.json has no engines field, and the test workflow does not use actions/setup-node. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
mise and asdf write .tool-versions into the working copy, where it showed up as untracked noise in git status. It is a personal pin rather than a project one, so ignore it instead of committing it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2 participants
The README had drifted from the repository. Corrections:
>= 0.123.0;package.jsonpinshugo-extended ^0.163.0and.github/workflows/test.ymlbuilds with 0.163.1.npm installprovides Hugo extended via thehugo-extendedpackage, so a system-wide install is optional. This was not mentioned.hugo serveonly. Added a table of the npm scripts that exist, includingdev:start:with-pagefind, which is the only way site search works locally.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..tool-versions, the devcontainer, the separatehugo -s subsite/docsbuild that CI merges intopublic/docs, and what the test workflow checks.Stale npm output (package counts from an old
npm install) was dropped.🤖 Generated with Claude Code