Skip to content

Commit 9b143c9

Browse files
committed
PR feedback
1 parent 9697e6b commit 9b143c9

37 files changed

Lines changed: 799 additions & 475 deletions

.llm/context.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -828,6 +828,8 @@ Workflow syntax errors are easy to introduce and tedious to debug in CI. Always
828828

829829
### Documentation Changes
830830

831+
> **See also:** [documentation-code-consistency.md](skills/documentation-code-consistency.md) — Keeping docs and code in sync, verifying CHANGELOG accuracy, error documentation patterns.
832+
831833
**Run after modifying any rustdoc comments:**
832834

833835
```bash

.llm/skills/changelog-practices.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,8 +281,28 @@ rg 'changed_function|ChangedStruct' --type rust --type md
281281

282282
---
283283

284+
## Verification Before Committing
285+
286+
**Always verify CHANGELOG claims match actual code:**
287+
288+
```bash
289+
# Verify derives exist before claiming them
290+
rg '#\[derive.*Hash' src/lib.rs
291+
292+
# Verify method/type exists
293+
rg 'pub fn method_name|pub struct TypeName' --type rust
294+
295+
# Build docs to catch broken links
296+
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps
297+
```
298+
299+
> **See also:** [documentation-code-consistency.md](documentation-code-consistency.md) for comprehensive verification commands and common pitfalls.
300+
301+
---
302+
284303
## References
285304

286305
- [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
287306
- [Semantic Versioning](https://semver.org/)
288307
- [Rust API Guidelines - Documentation](https://rust-lang.github.io/api-guidelines/documentation.html)
308+
- [documentation-code-consistency.md](documentation-code-consistency.md) — Keeping docs and code in sync

0 commit comments

Comments
 (0)