Skip to content

docs: complete Taylor-kay documentation issues (#727, #729, #726, #722) #834

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

Merged
BigBen-7 merged 2 commits into from
Aug 28, 2026
Merged

docs: complete Taylor-kay documentation issues (#727, #729, #726, #722) #834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b92584c
docs: add rustdoc to contract.rs and expand changelog (closes #727, #…
Taylor-Kay Aug 28, 2026
8706e6c
Merge branch 'main' into taylor-kay/docs-722-726-727-729
BigBen-7 Aug 28, 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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ for contract upgrades.
- Pre-commit hook (`make install-hooks`) running `cargo fmt` and `cargo clippy` before every commit.
- CHANGELOG.md tracking all significant changes per release.
- Inline doc comments explaining the purpose of each test scenario across all test files.
- Inline `///` rustdoc for every public function in `src/contract.rs` (one-line
summary, `# Arguments`, `# Panics`, and `# Example`).
- Error code catalog (`docs/error-codes.md`) mapping every panic string to its
module, cause, and recommended caller handling.
- Architecture document (`docs/architecture.md`) covering module responsibilities,
data flow, storage layout, auth model, events, and integration points.
- `transfer_recurring_payer` — transfer a recurring payment to a new payer with
Expand Down
Loading