Skip to content

Add Documentation DO/DON'T section in agents.md #1103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
suri-kumkaran wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −0
Open

Add Documentation DO/DON'T section in agents.md #1103

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f7d7e1
Add agents docs guidance
suri-kumkaran May 25, 2026
2e6d055
Remove recomendation to run cargo doc
suri-kumkaran May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,19 @@ CI workflow is defined in [`.github/workflows/ci.yml`](.github/workflows/ci.yml)
- Add tests for derived traits (Clone, Debug, PartialEq)
- Add tests for enums unless they have explicit functionality

### Documentation

Less is more. Documentation goes out of date; rustdoc-generated output doesn't. Don't duplicate what rustdoc already provides for free (type listings, signatures, re-exports, intra-doc links).

**DO**:
- Document non-obvious behavior, errors, safety, and design intent
- Use `# Errors`, `# Safety`, `# Panics`, `# Example` sections

**DON'T**:
- Maintain explicit lists of types/functions in module-level docs
- Restate what the signature already shows (e.g. "owns an `Arc<T>`" on a struct whose only field is `Arc<T>`)
- Document internal `pub(crate)` / `pub(super)` items unless intent isn't obvious from usage

---

## Pre-commit Checklist
Expand Down
Loading