Skip to content

Conversation

malgus01
Copy link
Contributor

Pull Request

Summary

This PR introduces a new documentation workflow powered by Forge, including commands to generate and serve project documentation locally.

Changes

  • Added NatSpec header section for improved documentation organization.
  • Updated Makefile with:
    • docs → generates documentation into the $(DOCS_DIR) directory using forge doc.
    • docs-serve → serves the generated documentation locally at http://localhost:3000.
  • Added console output for better DX when generating/serving docs.

Motivation

  • Streamline developer experience by making it easier to:
    • Generate contract documentation from NatSpec comments.
    • Preview documentation locally during development.
  • Improves overall clarity and maintainability of the codebase.

Next Steps

  • Configure CI pipeline to auto-generate and publish docs.
  • Expand NatSpec coverage across all contracts for richer documentation.

@0xRiz0 0xRiz0 self-requested a review September 21, 2025 16:07
@0xRiz0 0xRiz0 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 21, 2025
@0xRiz0 0xRiz0 merged commit 67829d0 into FlashArb-AI:main Sep 21, 2025
1 check failed
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants