docs: add ARCHITECTURE.md (#21) - #48
Open
malaysiaonelove wants to merge 1 commit into
Open
Conversation
…, and extension guide Closes Kqirox#21 - System overview Mermaid diagram covering all 6 contracts - Cross-contract call graph (sequence diagram + call table with source links) - Trust boundary analysis: principal hierarchy, invariants, recovery flows - Per-contract deep-dives: storage layout, auth model, events, constants - Step-by-step wiring/deployment guide with stellar CLI commands - Full panic catalog for all 6 contracts - Extension guide: new contracts, events, admin roles, storage keys - .markdownlint.json to configure lint rules for the repo
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
ARCHITECTURE.md— the canonical architecture reference for the Orivex Contracts repository, as specified in issue #21.Closes #21
What's included
stellar contract invokecommands and a Mermaid dependency flowchartcargo docAlso adds
.markdownlint.jsonto configure lint rules repo-wide (disables MD013 line-length, scopes MD024 to siblings-only).Acceptance criteria checklist
markdownlint-cli2: 0 issues)10.x, standard GFM tables)