docs: bilingual architecture doc (EN + RU)#1
Conversation
Add docs/architecture/ARCHITECTURE.md and ARCHITECTURE.ru.md — a deep, file:line-backed architecture reference for the SDK (facade → transport → types/errors layering, RFQ/HTLC flows, the experimental agent-attestation layer), mirroring the hashlock-markets master-doc template and cross-linking back to it. Link the README to the new doc. Phase 2 of the architecture-docs effort (per-repo sibling docs). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR adds comprehensive architecture documentation for the ChangesArchitecture Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What
Adds a deep, bilingual architecture reference for
@hashlock-tech/sdk, mirroring the hashlock-markets master-doc template and cross-linking back to it.docs/architecture/ARCHITECTURE.md(English)docs/architecture/ARCHITECTURE.ru.md(Russian parity)This is Phase 2 of the architecture-docs effort — per-repo docs inside each core product sibling repo (Phase 1 = the merged master doc).
Shape (matches the template)
path:lineDepth
Architecture & flow comprehension — points into code, doesn't duplicate it:
HashLockover a privateGraphQLClient)Honest flags (not fixed here — out of scope for a docs PR)
The doc surfaces, rather than silently corrects, real doc-drift in the repo: README prose examples +
.env.examplestill cite the superseded/compromised142.93.106.129IP while the code's canonicalMAINNET_ENDPOINTishttps://hashlock.markets/graphql; package is@hashlock-tech/sdkthough some snippets import@hashlock/sdk;CHANGELOG.mdlagspackage.json(0.1.4 vs 0.2.0).Verification
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation