Skip to content

Conversation

@jhuhnke
Copy link
Contributor

@jhuhnke jhuhnke commented Dec 4, 2025

Summary

Update Compose documentation to reflect use of Solidity modules

Changes Made

This pull request only touches the content of documentation on the Compose website. It does not make updates to any Compose contract nor does it update webpage styling.

Mentions of Solidity libraries have been updated to solidity modules within the documentation. This is following the update of the codebase from libraries to modules to "future-proof" and prepare for the eventual changes of Core Solidity. Where appropriate, example code blocks have also been changed to use the new file naming convention (e.g. ERC20Mod.sol)

Checklist

Before submitting this PR, please ensure:

  • Code follows the Solidity feature ban - No inheritance, constructors, modifiers, public/private variables, external library functions, using for directives, or selfdestruct

  • Code follows Design Principles - Readable, uses diamond storage, favors composition over inheritance

  • Code matches the codebase style - Consistent formatting, documentation, and patterns (e.g. ERC20Facet.sol)

  • Code is formatted with forge fmt

  • Existing tests pass - Run tests to be sure existing tests pass.

  • New tests are optional - If you don't provide tests for new functionality or changes then please create a new issue so this can be assigned to someone.

  • All tests pass - Run forge test and ensure everything works

  • Documentation updated - If applicable, update relevant documentation

Make sure to follow the contributing guidelines.

Additional Notes

@netlify
Copy link

netlify bot commented Dec 4, 2025

👷 Deploy request for compose-diamonds pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit cf51907

@mudgen
Copy link
Contributor

mudgen commented Dec 4, 2025

@jhuhnke Good work, thanks for your help with this.

@mudgen mudgen merged commit 54bb3c8 into Perfect-Abstractions:main Dec 4, 2025
3 checks passed
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.

2 participants