Diamond Core - Contracts Documentation

[maxnorm]

Summary

Changes Made

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

• Changesets — If this PR changes publishable packages (src/, cli/), changeset-bot will comment if a release note might be needed. You can add one when convenient or defer to maintainers.

Make sure to follow the contributing guidelines.

Additional Notes

[netlify]

👷 Deploy request for compose-diamonds pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	19c9220

[changeset-bot]

⚠️ No Changeset found

Latest commit: 19c9220

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

Coverage Report

Metric	Coverage	Details
Lines	79%	1560/1981 lines
Functions	92%	445/483 functions
Branches	74%	161/217 branches

Last updated: Sat, 02 May 2026 01:12:49 GMT for commit 19c9220

[github-actions]

Gas Report

No gas usage changes detected between main and release-docs-1.

All functions maintain the same gas costs. ✅

Last updated: Sat, 02 May 2026 01:13:20 GMT for commit 19c9220