docs: restructure into 7-section developer journey#18
Open
mHaines9219 wants to merge 43 commits intomainfrom
Open
docs: restructure into 7-section developer journey#18mHaines9219 wants to merge 43 commits intomainfrom
mHaines9219 wants to merge 43 commits intomainfrom
Conversation
…ourney Reorganize documentation from 4 sections (Getting Started / Onboarding / Core / Appendix) into 7 sections ordered by developer journey: Overview, Getting Started, Tutorials, Seismic Solidity, Client Libraries, Networks & Deployment, and Reference. Key changes: - Rewrite README.md as value-prop landing page leading with "one letter changes everything" - Add 3 new overview pages (why-seismic, how-seismic-works, use-cases) - Add 7-page SRC20 tutorial showing end-to-end private ERC20 token development - Expand events.md from 1 line to full page with AES precompile encryption pattern - Add storage, casting, and best-practices-and-gotchas pages for Seismic Solidity section - Add precompiles API reference, architecture overview, and Ethereum migration guide - Create 24 client library placeholder pages for team to port from client.seismic.systems - Move all existing pages to new locations and fix cross-references - Unhide development-toolkit, opcodes, terms-of-service, privacy-policy pages - Remove duplicate Walnut tutorial Chapter 3 file
cdrappi
added a commit
that referenced
this pull request
Feb 19, 2026
Add DEPOSIT_CONTRACT_ABI, helpers (compute_deposit_data_root, make_withdrawal_credentials), unit tests, integration tests, and README documentation for Seismic's Eth2-style validator deposit contract.
cdrappi
added a commit
that referenced
this pull request
Feb 19, 2026
Add EIP-712 structured data signing (message_version=2) as an alternative to raw signing (message_version=0) for TxSeismic transactions. This enables browser wallets (MetaMask, WalletConnect) to sign via eth_signTypedData_v4. - New module: seismic_web3.transaction.eip712 with domain_separator, struct_hash, eip712_signing_hash, build_seismic_typed_data, and sign_seismic_tx_eip712 - Pipeline integration: eip712=True parameter threaded through send_shielded_transaction, signed_call, ShieldedContract, and SeismicNamespace - 59 unit tests with cross-validation against seismic-alloy (Rust) - Integration tests exercising eip712=True through the full pipeline
cdrappi
added a commit
that referenced
this pull request
Feb 19, 2026
Point all iframe embeds to https://seismicsystems.github.io/seismic/rpc-terminal/
GitBook renders {% embed %} as a bookmark card for unknown URLs.
Raw <iframe> tags render the terminal inline as intended.
GitBook only renders full iframe embeds for recognized providers. Route through CodeSandbox (which loads from our gh-pages branch) so the terminal renders inline instead of as a bookmark card.
- JSON-RPC (interactive), TypeScript (viem), Python (requests), Rust (reqwest) - Syntax highlighting per language with copy buttons - Bottom padding to avoid CodeSandbox overlay obstruction - Code snippets update dynamically when endpoint changes
cdrappi
added a commit
that referenced
this pull request
Feb 19, 2026
Add EIP-712 structured data signing (message_version=2) as an alternative to raw signing (message_version=0) for TxSeismic transactions. This enables browser wallets (MetaMask, WalletConnect) to sign via eth_signTypedData_v4. - New module: seismic_web3.transaction.eip712 with domain_separator, struct_hash, eip712_signing_hash, build_seismic_typed_data, and sign_seismic_tx_eip712 - Pipeline integration: eip712=True parameter threaded through send_shielded_transaction, signed_call, ShieldedContract, and SeismicNamespace - 59 unit tests with cross-validation against seismic-alloy (Rust) - Integration tests exercising eip712=True through the full pipeline
Add ?embed=true param that applies tighter spacing, smaller fonts, and reduced min-heights so the terminal fits GitBook's fixed-height iframe without scrolling. Update all embed URLs.
- Remove eth_getBalance, eth_chainId, eth_blockNumber pages - Move "Try It" terminal embed to top of each remaining method page - Update SUMMARY.md and README.md to reflect removals
Merge main branch (python client SDK + docs) into docs restructure branch. Reorganize client docs under clients/: TypeScript (seismic-viem, seismic-react), Python (seismic-web3), and Rust (seismic-alloy). Remove old client-libraries placeholder section.
…structure-information-architecture
Merge system architecture content (Node, Summit, Enclave, fork chain, TEE guarantees) into the How Seismic Works overview page and remove the dead Architecture link from SUMMARY.md.
…structure-information-architecture
Add three diagrams from the internal architecture docs: - seismic-node.png: full node architecture inside TEE boundary - rpc-evm-storage.png: RPC/EVM/storage interaction and shielded slot enforcement - tries.png: block structure, state tries, and TxSeismic format
Replace single-file stub with full multi-page Python SDK documentation: - Installation, wallet client, public client, chains - Contract instance with 5 namespaces (.write/.read/.twrite/.tread/.dwrite) - Shielded writes, signed reads, precompiles, SRC20 token guide Content sourced from the live docs revision and structured to mirror the existing Seismic Viem section format.
Pull all 92 Python client pages from main's clients/python/ into client-libraries/seismic-python/ and update SUMMARY.md with the complete nav tree (Client, Contract, Chains, Precompiles, API Reference, Namespaces, SRC20, ABIs, Guides, Examples).
Copy 45 Alloy doc files to docs/clients/seismic-alloy/ and update the root docs/SUMMARY.md with the full navigation tree so GitBook picks them up.
Fill 12 placeholder files and create 6 new files for comprehensive seismic-react docs covering hooks, provider, chains, wallet guides, and examples. Add Chains and Examples subsections to root SUMMARY.md.
External developers using Claude Code get incorrect patterns for Seismic's new SDKs. Add a public-facing GitBook section with copy-paste CLAUDE.md templates for Solidity, Viem, React, Alloy, and Python that teach Claude the correct APIs, shielded type patterns, and common pitfalls. Also includes three optional workflow skills (deploy, debug, migrate ERC20→SRC20).
The Claude Code nav entries were incorrectly added to docs/gitbook/SUMMARY.md instead of the root docs/SUMMARY.md. Move them to the correct file with gitbook/-prefixed paths.
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
2 participants
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
Restructures the GitBook documentation from 4 sections (Getting Started / Onboarding / Core / Appendix) into 7 sections ordered by developer journey:
Key changes
onboarding/tutorial/totutorials/walnut/with shorter filenamescore/,onboarding/,appendix/) removed; files moved to new locationsWhat's NOT in this PR
Test plan