Skip to content

Conversation

@Daanvdplas
Copy link
Contributor

@Daanvdplas Daanvdplas commented Nov 6, 2025

Refactor:

  • Structure of the website
  • The toggle used for cc and pop-cli, pop-cli is now first because it is the tool with best devex. In addition, in the pages where possible contracts-ui is added.
  • getting started page simplified, none of the info is removed, just moved or it was already covered somewhere else.
  • moved anything related to building ink! contracts with solidity abi or other solidity contracts in dedicated section in the docs (removed ethereum tutorial and moved there too).

@Daanvdplas Daanvdplas requested a review from Copilot November 7, 2025 16:28
Copy link
Contributor

Copilot AI left a 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.

@cmichi
Copy link
Collaborator

cmichi commented Nov 7, 2025

@Daanvdplas

image

Those two nav items are not recognizable as such, they should have the same style as the others.

@Daanvdplas
Copy link
Contributor Author

Fixed the navigation bar @cmichi !

@Daanvdplas Daanvdplas requested a review from cmichi November 10, 2025 09:44
We intend to automatically generate this re-export in future releases of ink! v6.
:::

:::note
Copy link
Contributor Author

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.

Copy link
Collaborator

@davidsemakula davidsemakula left a 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.

@Daanvdplas
Copy link
Contributor Author

Closes #517

@Daanvdplas Daanvdplas merged commit 5d06b76 into master Nov 10, 2025
3 checks passed
@Daanvdplas Daanvdplas deleted the daan/refactor-major branch November 10, 2025 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants