Summary
The workspace has ~35 contracts but no unified reference for their public entry points or error codes. Contributors and integrators currently have to read each source file. A generated/curated API reference plus a shared error-code table would make the codebase far more approachable.
What we'd like
- A per-contract reference listing each public function, its arguments, auth requirements, and emitted events
- A single, shared error-code table so error values are unique and documented in one place
- Links from the top-level README into these docs
Where to look
soroban/src/ — all contract modules and their error enumssoroban/docs/ — existing docs to extend rather than duplicatesoroban/TRUSTED_SOURCE_IMPLEMENTATION.md — a good example of the documentation style to match
Acceptance criteria
Notes
Where possible, derive the docs from doc-comments (///) so they stay close to the code and easier to keep current.
Summary
The workspace has ~35 contracts but no unified reference for their public entry points or error codes. Contributors and integrators currently have to read each source file. A generated/curated API reference plus a shared error-code table would make the codebase far more approachable.
What we'd like
Where to look
soroban/src/— all contract modules and their error enumssoroban/docs/— existing docs to extend rather than duplicatesoroban/TRUSTED_SOURCE_IMPLEMENTATION.md— a good example of the documentation style to matchAcceptance criteria
ERRORS.mdmaps every error code to its meaning and originating contractNotes
Where possible, derive the docs from doc-comments (
///) so they stay close to the code and easier to keep current.