docs: add per-contract READMEs for six Stellar crates (#167) - #169
Merged
truthixify merged 1 commit intoAug 26, 2026
Merged
Conversation
|
@boalambo Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Merged. Six READMEs in one pass and the entrypoint tables match source. Thanks @boalambo. |
amosleoamadi
added a commit
to amosleoamadi/contracts
that referenced
this pull request
Aug 26, 2026
truthixify
pushed a commit
that referenced
this pull request
Aug 27, 2026
* docs(dx): add unified error code catalog with CI validation * docs: catalog stealth-vault errors added in #169
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds README.md files to the six Stellar crates that were missing documentation, closing #167. This documentation is load-bearing for the upcoming third-party audit engagement (#4).
Changes
⚠️ DELIBERATELY FROZENat the top.⚠️ LIBRARY, NOT A DEPLOYABLE CONTRACT.⚠️ NOT PRODUCTION READY — PROOF OF CONCEPT ONLY.Each new README follows the shared template:
PAUSE.md,MULTISIG.md,METRICS.md, andONCALL.mdNotes
ONCALL.mdis referenced per issue Cross-chain announcement schema conformance audit #12 but does not currently exist instellar/. Links are left in place per maintainer instruction, for when that file is added.Acceptance criteria
stellar/contracts/*andstellar/*(excludingbench,bench-crossover,integration-tests,shared) has a READMEstellar/README.mdcontracts table links to every crate READMECloses #167