Remove generated audit artifacts and redundant root documentation - #155
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughThe PR removes redundant API, layout, performance, safety, and architecture-report documents. It updates README references to maintained checks and adds a repository contract test that prevents the retired artifacts from being shipped or referenced. ChangesDocumentation and repository contracts
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Pull request overview
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Removes generated/duplicative documentation artifacts from the repo and updates repository contracts + README to point to test/workflow-backed evidence instead of standalone root docs.
Changes:
- Deleted the generated audit HTML artifact and four redundant root markdown docs.
- Updated README references to point at enforced tests/workflows/scripts as the source of truth.
- Added a repository-contract test to prevent the removed artifacts from being reintroduced/referenced.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/tests/test_repository_contracts.py | Adds a contract test guarding against reintroducing removed docs/audit artifacts and README references. |
| README.md | Replaces links to removed root docs with links to tests/scripts/workflows that enforce the same guarantees. |
| cheetah-string-architecture-performance-report.html | Removes generated audit HTML artifact from the repository. |
| API.md | Removes redundant root API compatibility doc (now enforced via tests/workflows). |
| LAYOUT.md | Removes redundant root layout doc (now enforced via tests). |
| PERFORMANCE.md | Removes redundant root performance contracts doc (now enforced via tests/scripts). |
| SAFETY.md | Removes redundant root safety model doc (now enforced via workflow + in-source contracts). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| def test_generated_audit_artifacts_are_not_shipped(self) -> None: | ||
| retired = ( | ||
| "API.md", | ||
| "LAYOUT.md", | ||
| "PERFORMANCE.md", | ||
| "SAFETY.md", | ||
| "cheetah-string-architecture-performance-report.html", | ||
| ) |
| for path in retired: | ||
| self.assertFalse((ROOT / path).exists(), path) | ||
| self.assertNotIn(path, readme) |
Closes #154
Summary
docs/directory untouched and excluded from release packagesRemoved files
cheetah-string-architecture-performance-report.htmlAPI.mdLAYOUT.mdPERFORMANCE.mdSAFETY.mdVerification
cargo fmt --all -- --checkcargo clippy --all-targets --all-features -- -D warningscargo test --all-features(203/203)cargo test --no-default-features --features serde,bytes,simd-D warningscargo package --allow-dirty(74 files, 334.1 KiB; 71.9 KiB compressed)docs/**entriesSummary by CodeRabbit