Skip to content

docs: add CLAUDE.md with build and spelling commands - #305

Draft
fzipi wants to merge 1 commit into
mainfrom
claude/improve-claude-md-2026-10-20
Draft

fzipi wants to merge 1 commit into
mainfrom
claude/improve-claude-md-2026-10-20

Conversation

@fzipi

@fzipi fzipi commented Oct 20, 2026

Copy link
Copy Markdown
Member

Requested by Felipe · project thread

PRs read: 1 · days covered: 30 · helpers started: 0. The PRs are a sample.

Proposed changes

Before: no CLAUDE.md, so agents have to work out how the site builds and that CI rejects British spellings.

After: a root CLAUDE.md says where pages live, how to build and preview, and which spelling check runs. Hugo renders only content/, so the file does not appear on the site.

No review-based edits this run: only one agent PR (#304) was opened in the last 30 days, and a rule needs the same mistake in at least two.

Checked in the repository, not tested

Line Proof
Pages under content/, theme submodule under themes/ README.md:26, .gitmodules
Build hugo --minify, Hugo extended; preview hugo serve .github/workflows/test.yml:51, README.md:15, :32
Spelling check, American English .github/workflows/test.yml:53-58, .github/workflows/english_test.sh:2

This test shows that an agent now catches the mistake when it re-reads its own diff. It does not show that the mistake will never be written. (No edit was tested this run; the lines above are starter lines only.)

Further comments

Checks run: .github/workflows/english_test.sh passes, and the word list finds nothing in CLAUDE.md. The Hugo build and link check could not run (Hugo is not installed here). CLAUDE.md ends with a newline, has no trailing whitespace, and is the only file changed.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Wb84Rc1EqnGBarcdrjLLoY

Revert: git revert <merge commit> or delete CLAUDE.md.


Generated by Claude Code

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Wb84Rc1EqnGBarcdrjLLoY
@coderabbitai

coderabbitai Bot commented Oct 20, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@fzipi fzipi self-assigned this Oct 20, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying crs-documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7f11d9c
Status: ✅  Deploy successful!
Preview URL: https://491e83ea.documentation-km5.pages.dev
Branch Preview URL: https://claude-improve-claude-md-202.documentation-km5.pages.dev

View logs

This branch has not been deployed

No deployments
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