docs(ecosystem-adapters): add comprehensive documentation for OpenZeppelin Ecosystem Adapters#142
Open
pasevin wants to merge 9 commits intoOpenZeppelin:mainfrom
Open
Conversation
…pelin Ecosystem Adapters - Add 5 documentation pages: overview, architecture, getting started, supported ecosystems, building an adapter - Include Mermaid diagrams for package topology, capability tiers, profiles, runtime lifecycle, and execution strategies - Add navigation config (ecosystem-adapters.json) and wire into sidebar - Add Ecosystem Adapters section to ethereum-evm.json navigation under Open Source Tools - Register ecosystemAdaptersTree in navigation index and use-navigation-tree hook Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…x with flowchart subgraphs The block-beta diagram type causes a circular JSON serialization error in the Mermaid component. Replace with flowchart subgraphs which render correctly with colored tier groupings. Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…rint - Overview: replace expanded 13-node tier tree with compact 3-node summary - Architecture: replace oversized Mermaid tier diagram with a single clean table - Removes redundant duplicate tier table Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…capability matrix The Mermaid flowchart with cross-links between profiles and capabilities created a cluttered spider-web visual. Replaced with a single clear checkmark matrix table that shows exactly which capabilities each profile includes at a glance. Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…mary table The Mermaid subgraph cards took excessive vertical space for minimal info. Replaced with a single 5-row table showing adapter, networks, capability count, and status. Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
- Add 'Using with React' section covering wallet context providers, configureUiKit, connectWallet/disconnectWallet, and hook facade pattern (useAccount, useSwitchChain, etc.) - Add 'Multi-Ecosystem Apps' section showing how to instantiate runtimes from EVM + Stellar adapters in the same application - Add prominent link to the adapters GitHub repo on the overview page - All API details referenced from adapter source code Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…ation-27d3 feat(ecosystem-adapters): add React integration and multi-ecosystem documentation
Add the Ecosystem Adapters folder to Stellar, Polkadot, Midnight, and Arbitrum Stylus navigation trees so the section is discoverable from every supported ecosystem, not just EVM. Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…ation-27d3 feat(navigation): add Ecosystem Adapters to all ecosystem sidebars
👷 Deploy request for openzeppelin-docs-v2 pending review.Visit the deploys page to approve it
|
5 tasks
pasevin
changed the title
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.
Documentation Pull Request
Summary
Adds a new 5-page documentation section for OpenZeppelin Ecosystem Adapters — the modular, chain-specific integration packages that bridge blockchain ecosystems and developer tooling.
Pages added:
/ecosystem-adapters)/ecosystem-adapters/architecture)/ecosystem-adapters/getting-started)/ecosystem-adapters/supported-ecosystems)/ecosystem-adapters/building-an-adapter)Diagrams included (rendered via Mermaid):
Tables used for matrix data (cleaner than flowcharts for cross-references):
Type of Change
Related Issues
Relates to https://github.com/OpenZeppelin/openzeppelin-adapters
Checklist
pnpm run buildpnpm run checkAdditional Notes
ethereum-evm.json,stellar.json,polkadot.json,midnight.json, andarbitrum-stylus.json) under Open Source Tools for discoverability.Callout,Card,Cards) and Mermaid diagrams — no custom imports needed.flowchartandsequenceDiagramtypes only (avoiding unsupported types likeblock-beta).