Skip to content

docs: Refine documentation and add Claude AI guidance#214

Merged
SmetDenis merged 3 commits intomasterfrom
docs
Sep 28, 2025
Merged

docs: Refine documentation and add Claude AI guidance#214
SmetDenis merged 3 commits intomasterfrom
docs

Conversation

@SmetDenis
Copy link
Copy Markdown
Member

  • Add CLAUDE.md to provide guidance for Claude Code AI.
  • Correct "weather" to "whether" in is_hex_rgb_color rule descriptions.
  • Fix "debbuging" to "debugging" in GitHub Action and README descriptions.
  • Update "messege" to "message" in help message summaries in README.md.
  • Adjust runCommand parameter in tests/Tools.php for consistency.

- Add `CLAUDE.md` to provide guidance for Claude Code AI.
- Correct "weather" to "whether" in `is_hex_rgb_color` rule descriptions.
- Fix "debbuging" to "debugging" in GitHub Action and README descriptions.
- Update "messege" to "message" in help message summaries in `README.md`.
- Adjust `runCommand` parameter in `tests/Tools.php` for consistency.
Previously, all `.md` files were linted, which could include documentation or other markdown files not intended for this specific linting pass. This change focuses the markdownlint action solely on the main `README.md` file, ensuring consistent linting for the primary project overview without imposing strict rules on other markdown assets.
Explicitly set `contents: read` for GitHub Actions workflows. This follows the principle of least privilege and improves security by ensuring workflows only have necessary permissions.
@SmetDenis SmetDenis merged commit 6b49cef into master Sep 28, 2025
12 checks passed
@SmetDenis SmetDenis deleted the docs branch September 28, 2025 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant