Skip to content

docs: align README and CLAUDE docs with tooling and layout#42

Merged
buddingengineers12345 merged 1 commit intomainfrom
docs/sync-readme-claude-md
Apr 17, 2026
Merged

docs: align README and CLAUDE docs with tooling and layout#42
buddingengineers12345 merged 1 commit intomainfrom
docs/sync-readme-claude-md

Conversation

@buddingengineers12345
Copy link
Copy Markdown
Owner

Summary

Refreshes README and CLAUDE documentation to match current meta-repo layout, just recipes (check vs test-ci-matrix, audit), and template workflow filenames.

Changes introduced

  • Root CLAUDE.md and README.md: script_imports, check/audit clarity, rules tree, dedupe just review
  • tests/CLAUDE.md: path helpers and tests/unit/ layout
  • template/CLAUDE.md and template/CLAUDE.md.jinja: workflows and rules tree
  • .claude/rules/README.md (mirrored): copier entry in structure

Testing

  • just sync-check
  • uv run pytest tests/unit/ -q --no-testmon

Documentation

  • Updated existing documentation

Thank you for your contribution.

Made with Cursor

- Root CLAUDE: script_imports, check vs test-ci-matrix, audit, rules tree
- README: dedupe review, clarify check/test-ci-matrix/audit
- tests/CLAUDE: paths, package layout under tests/unit
- template CLAUDE: workflow filenames; jinja rules tree
- rules README: copier/template-conventions in structure tree

Made-with: Cursor
@github-actions github-actions bot added documentation Improvements or additions to documentation template tests labels Apr 17, 2026
@buddingengineers12345 buddingengineers12345 merged commit c9488e7 into main Apr 17, 2026
9 checks passed
@buddingengineers12345 buddingengineers12345 deleted the docs/sync-readme-claude-md branch April 17, 2026 01:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation template tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants