-
Notifications
You must be signed in to change notification settings - Fork 86
refactor: structure refactor and docs improvements. #518
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
46e7a02 to
2508418
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR performs a major documentation restructuring for ink! v6, reorganizing content into clearer categories and adding comprehensive Solidity interoperability documentation. The changes remove outdated tutorial content and establish a new "Ink & Solidity" section with detailed guides for using Ethereum tooling with ink! contracts.
Key Changes:
- Removes Ethereum Compatibility tutorial section and replaces it with comprehensive Solidity Interoperability documentation
- Restructures sidebar navigation from nested objects to flat arrays with categorized sections
- Adds new "Getting Started" testing guide and reorganizes advanced topics into separate sections
- Updates 200+ internal documentation links to reflect new file paths
Reviewed Changes
Copilot reviewed 52 out of 92 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tutorials/sidebar.js | Removed Ethereum Compatibility section |
| tutorials/ethereum-compatibility/* | Deleted outdated tutorial files (content replaced in docs/solidity-interop) |
| docs/solidity-interop/* | Added comprehensive guides for Solidity ABI, MetaMask, Hardhat, Wagmi integration, and type references |
| sidebars.js | Major restructuring: flattened structure, reorganized into clear sections (Basics, Advanced, Development, Reference) |
| docs/getting-started/testing.md | New guide for testing contracts |
| docs/reference/macros-attributes/* | Added documentation for all ink! macros and attributes |
| docs/advanced/* | Moved advanced topics (XCM, upgradeability, precompiles, environment, datastructures) |
| docs/development/* | Consolidated testing, debugging, linting, and verification documentation |
| Various link updates | Updated internal references to match new file structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Fixed the navigation bar @cmichi ! |
| We intend to automatically generate this re-export in future releases of ink! v6. | ||
| ::: | ||
|
|
||
| :::note |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This content and below have been moved to a page Calling Solidity Contracts.
92e90ab to
d8481d0
Compare
davidsemakula
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice!
I've left a few comments/suggestions below.
|
Closes #517 |

Refactor: