Skip to content

Conversation

@maxnorm
Copy link
Collaborator

@maxnorm maxnorm commented Nov 3, 2025

Summary

Add comprehensive documentation & blog website with a complete collection of components to build our doc.

See Result
Deployment on Netlify: https://docusaurus.io/docs/deployment#deploying-to-netlify

See the .env.example file for env variable to set:
Algolia Configuration: https://docusaurus.io/docs/search#using-algolia-docsearch
DocSearch: https://docsearch.algolia.com/

Changes Made

  • created a docusaurus project
  • configure the theme to fit Compose brand
  • created a full colllection of 30+ reusable components to build markdown x (.mdx) doc pages. HERE
  • added default content template/example of pages for the docs & blog (ps: we will need to rework for the actual content)
  • created a simple CI actions to build and lint the docs

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

  • Tests are included - All new functionality has comprehensive tests

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

  • Documentation updated - If applicable, update relevant documentation

Make sure to follow the CONTRIBUTING.md guidelines.

Additional Notes

@github-actions
Copy link

github-actions bot commented Nov 3, 2025

Coverage Report

Coverage

Metric Coverage Details
Lines 49% 667/1370 lines
Functions 62% 143/232 functions
Branches 25% 63/249 branches

Last updated: Mon, 03 Nov 2025 18:30:41 GMT for commit a0418af

@github-actions
Copy link

github-actions bot commented Nov 3, 2025

Gas Report

No gas usage changes detected between main and feat/docs.

All functions maintain the same gas costs. ✅

Last updated: Mon, 03 Nov 2025 18:31:00 GMT for commit a0418af

@maxnorm maxnorm marked this pull request as ready for review November 3, 2025 18:32
@maxnorm maxnorm requested a review from mudgen November 3, 2025 18:33
@maxnorm maxnorm added the documentation Improvements or additions to documentation label Nov 3, 2025
@mudgen mudgen merged commit ede51c9 into Perfect-Abstractions:main Nov 3, 2025
5 checks passed
JackieXu pushed a commit to JackieXu/Compose that referenced this pull request Nov 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants