Refresh docs and prevent unnecessary CI runs on docs changes

[sangwa]

Summary by CodeRabbit

• Chores

  • Optimized CI/CD workflows to prevent unnecessary runs on documentation-only changes.

• Documentation

  • Updated configuration and build process documentation with additional details.
  • Updated CI/CD workflow and branch protection documentation.

[coderabbitai]

Walkthrough

This pull request updates GitHub Actions workflows to skip CI runs for documentation-only changes. The ci.yml and nix-build.yml workflows now include paths-ignore filters that exclude Markdown files, LICENSE, and NOTICE from triggering pipeline execution. Supporting documentation in CLAUDE.md was updated to explain the configuration validation behavior, Nix build reference stripping, and the new CI/CD workflow skipping logic along with branch protection guidance for handling skipped status checks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hops past the docs with glee,
CI workflows now run lean and free,
Markdown and licenses need not apply,
Keeping our pipelines swift and spry! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: updating documentation in CLAUDE.md and configuring CI workflows to skip on documentation-only changes via paths-ignore filters.
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
• Commit unit tests in branch docs/update

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

CLAUDE.md (1)

46-46: Consider breaking up this long sentence for better readability.

The sentence contains multiple distinct concepts (priority order, validation rules, parsing behavior, failure modes) in over 100 words. While technically correct, splitting it into 2-3 sentences would improve clarity.

♻️ Optional readability improvement

-Configuration is loaded via a TOML config file, environment variables, and CLI flags. Priority (highest to lowest): CLI flags > env vars > config file > defaults. `LoadConfig` validates all values at startup: duration fields reject negative values (`parseDuration`), timeout and interval fields (`endorsements.client.timeout`, `revocation.refresh_interval`, `ratelimit.stall_timeout`) additionally reject zero, byte-size fields use `dustin/go-humanize` for parsing with int64 overflow protection, and invalid durations or byte sizes fail the startup.
+Configuration is loaded via a TOML config file, environment variables, and CLI flags. Priority (highest to lowest): CLI flags > env vars > config file > defaults. 
+
+`LoadConfig` validates all values at startup. Duration fields reject negative values (`parseDuration`), and timeout/interval fields (`endorsements.client.timeout`, `revocation.refresh_interval`, `ratelimit.stall_timeout`) additionally reject zero. Byte-size fields use `dustin/go-humanize` for parsing with int64 overflow protection. Invalid durations or byte sizes cause startup failure.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 46, The long description should be split into 2–3 clearer
sentences: update the paragraph that documents LoadConfig so the first sentence
states the configuration sources and priority (CLI flags > env vars > config
file > defaults), the second sentence lists validation rules (duration fields
reject negative values via parseDuration; endorsement.timeout,
revocation.refresh_interval, and ratelimit.stall_timeout also reject zero), and
an optional third sentence describes parsing behavior and failure modes
(byte-size fields parsed with dustin/go-humanize with int64 overflow protection
and invalid durations/byte sizes causing startup failure). Ensure references to
LoadConfig, parseDuration, endorsements.client.timeout,
revocation.refresh_interval, ratelimit.stall_timeout, and dustin/go-humanize
remain in the text.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CLAUDE.md`:
- Line 46: The long description should be split into 2–3 clearer sentences:
update the paragraph that documents LoadConfig so the first sentence states the
configuration sources and priority (CLI flags > env vars > config file >
defaults), the second sentence lists validation rules (duration fields reject
negative values via parseDuration; endorsement.timeout,
revocation.refresh_interval, and ratelimit.stall_timeout also reject zero), and
an optional third sentence describes parsing behavior and failure modes
(byte-size fields parsed with dustin/go-humanize with int64 overflow protection
and invalid durations/byte sizes causing startup failure). Ensure references to
LoadConfig, parseDuration, endorsements.client.timeout,
revocation.refresh_interval, ratelimit.stall_timeout, and dustin/go-humanize
remain in the text.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 273b9c2c-1631-4368-90a3-82353913c684

📥 Commits

Reviewing files that changed from the base of the PR and between a01e314 and b6e624c.

📒 Files selected for processing (3)

• .github/workflows/ci.yml
• .github/workflows/nix-build.yml
• CLAUDE.md