Skip to content

docs: release diamond-core docs and docs generation action/scripts from contract source#338

Merged
maxnorm merged 160 commits intoPerfect-Abstractions:mainfrom
maxnorm:release/docs-1
May 2, 2026
Merged

docs: release diamond-core docs and docs generation action/scripts from contract source#338
maxnorm merged 160 commits intoPerfect-Abstractions:mainfrom
maxnorm:release/docs-1

Conversation

@maxnorm
Copy link
Copy Markdown
Collaborator

@maxnorm maxnorm commented May 2, 2026

Summary

This PR adds and integrates the docs generation workflow for Compose contract documentation, including automation scripts and CI action updates. It also includes related documentation and site updates needed to publish and maintain generated docs.

Changes Made

  • Added GitHub Action workflow for docs generation and trigger controls. (Beta work, will need more modifications after reviewing all docs pages)
  • Added/updated supporting scripts for docs generation, templating, and release-note handling.
  • Improved docs generation prompts/templates and contract type detection for facets/modules.
  • Updated documentation pages and library structure to align with generated output (with Diamond Core docs as the primary published set for now).
  • Updated related package/workspace and release tooling config needed by the docs generation pipeline.

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
Copy link
Copy Markdown

netlify Bot commented May 2, 2026

Deploy Preview for compose-diamonds ready!

Name Link
🔨 Latest commit bd20b9d
🔍 Latest deploy log https://app.netlify.com/projects/compose-diamonds/deploys/69f6513b7881fa00088d86b7
😎 Deploy Preview https://deploy-preview-338--compose-diamonds.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 2, 2026

⚠️ No Changeset found

Latest commit: bd20b9d

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
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 2, 2026

Coverage Report

Coverage

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

Last updated: Sat, 02 May 2026 19:33:31 GMT for commit bd20b9d

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 2, 2026

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 19:33:57 GMT for commit bd20b9d

@maxnorm maxnorm changed the title Release/docs 1 docs: release diamond-core docs and docs generation action/scripts from contract source May 2, 2026
@maxnorm maxnorm merged commit abc04bb into Perfect-Abstractions:main May 2, 2026
11 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.

1 participant