docs: Add comprehensive architecture documentation#51
Merged
Conversation
- Add devnet architecture documentation with Docker orchestration details - Add transaction flow state machine documentation - Add coin selection algorithm documentation - Add script evaluation documentation with custom evaluator support - Add unfrack optimization documentation - Add architecture navigation structure - Include multiple Mermaid diagrams with proper contrast and accessibility - Replace deferred-execution with devnet in navigation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive documentation infrastructure and refactors the Data module's ByteArray representation from Uint8Array to hex strings. The PR introduces Twoslash-powered code examples, documentation generation tooling, and extensive new documentation pages covering wallets, transactions, and client usage.
Key changes:
- Data module refactor: Changed
Data.ByteArrayfromUint8Arrayto hex string representation for consistency - Documentation infrastructure: Added Fumadocs Twoslash integration for interactive TypeScript code examples with type information
- Documentation content: Created comprehensive guides for wallets, transactions, clients, and providers
- Tooling improvements: Enhanced documentation generation scripts with grouping support and skip tags
Reviewed Changes
Copilot reviewed 142 out of 143 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/evolution/src/core/Data.ts | Refactored ByteArray from Uint8Array to hex string representation |
| packages/evolution/src/core/TSchema.ts | Simplified ByteArray schema to use hex string directly |
| packages/evolution/test/Data.test.ts | Updated tests to expect hex strings instead of Uint8Array |
| packages/evolution/src/sdk/wallet/WalletNew.ts | Enhanced documentation with detailed JSDoc comments |
| packages/evolution/src/sdk/wallet/Wallet.ts | Removed deprecated wallet implementation file |
| packages/evolution/src/sdk/provider/*.ts | Added comprehensive JSDoc documentation to provider classes |
| packages/evolution/src/sdk/client/*.ts | Improved documentation and cleaned up implementation comments |
| docs/package.json | Added Twoslash dependencies for interactive code examples |
| docs/source.config.ts | Configured Shiki themes and Twoslash transformer |
| docs/scripts/*.ts | Enhanced documentation generation with grouping and filtering |
| docs/content/docs/**/*.mdx | Added extensive documentation for wallets, transactions, and providers |
| pnpm-lock.yaml | Updated dependencies including Twoslash, Mermaid, and related packages |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Overview
This PR adds extensive architecture and user documentation for the Evolution SDK.
Architecture Documentation
Core Architecture Concepts
User Documentation Sections
Documentation Philosophy
First Principles Approach
Visual Communication
Content Organization