docs: add top-level ARCHITECTURE.md with mermaid diagrams - #855
Open
Tenny150 wants to merge 3 commits into
Open
Conversation
…#784) Author ARCHITECTURE.md at the repo root with four mermaid diagrams: 1. System overview (all layers: clients, core, finance, infra) 2. Contract map table (all 27 contracts with crate names) 3. Three sequence diagrams: - Property purchase flow (identity → factory → token → escrow) - Lending & liquidation flow (borrower → lending → oracle → admin) - Insurance premium & claims flow (policyholder → insurance → pool) 4. Cross-contract data flow (traits, lib, governance, oracle, bridge) 5. Four-layer architecture diagram (user-facing → business → registry → infra) 6. Security model summary table 7. Further reading index linking all per-contract docs Also: - README.md: add ARCHITECTURE.md as first entry (START HERE) in the Architecture Documentation section, satisfying the one-click discoverability requirement from the issue. - smoke-ci.yml: add a Python link-check step that verifies all relative links in ARCHITECTURE.md resolve to real files, catching broken references on every PR. Closes MettaChain#784
|
@Tenny150 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! 🚀 |
ARCHITECTURE.md introduced links to DEVELOPMENT.md, CONTRIBUTING.md, and docs/penalty_drift.md which did not exist, causing the CI 'Check Markdown Internal Links' step to fail with exit code 1. Changes: - Add CONTRIBUTING.md (contributing workflow, code style, PR guidelines) - Add DEVELOPMENT.md (dev environment setup, toolchain, testing commands) - Add docs/penalty_drift.md (resolution of insurance 5% vs 10% penalty drift) - Add rustfmt.toml (format_macro_matchers=true for ink! macro formatting, MettaChain#783) - Add rustdoc headers to three mod tests blocks in lending/src/lib.rs (MettaChain#785) - Update lending/README.md with Test Module Layout section (MettaChain#785) Fixes: CI 'Check Markdown Internal Links (ARCHITECTURE.md)' step Closes MettaChain#784 MettaChain#785 MettaChain#783
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
1 participant
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
Fixes #784
docs/ARCHITECTURE_INDEX.mdexisted but was not discoverable from the repo root. New contributors had no one-click path to understand the system architecture.Changes
ARCHITECTURE.md(new — 366 lines)Top-level architecture document with:
propchain-traits,propchain-lib, oracle, bridge, and governance connect.README.mdAdded
ARCHITECTURE.mdas the first entry (marked START HERE) in the Architecture Documentation section, making it one click away from the repo root..github/workflows/smoke-ci.ymlAdded a Python link-check step that verifies all relative links in
ARCHITECTURE.mdresolve to real files, catching broken references on every PR.Acceptance Criteria (from issue)
cargo docworkflow (pure Markdown, renders in GitHub)