Skip to content

docs: expand inline documentation for smart contracts#303

Open
Hobie1Kenobi wants to merge 1 commit into
base:mainfrom
Hobie1Kenobi:swarm-bounty-279-cd69bcd1
Open

docs: expand inline documentation for smart contracts#303
Hobie1Kenobi wants to merge 1 commit into
base:mainfrom
Hobie1Kenobi:swarm-bounty-279-cd69bcd1

Conversation

@Hobie1Kenobi
Copy link
Copy Markdown

Addresses #279 by expanding inline documentation across the codebase to make contracts easier for contributors to understand.

Changes

scripts/libraries/ForgeArtifacts.sol

  • Added detailed NatSpec @param and @return tags to functions missing them
  • Added inline comments explaining non-obvious logic (JSON field order, semver stripping, OZ v4/v5 init checks, FFI safety)

README.md

  • Added Contract Architecture section (bridge hierarchy)
  • Added Key Concepts (proxied, predeployed, initialization)
  • Added Directory Structure and Testing with Forks sections
  • Added Contributing documentation guidelines

Made with Cursor

@cb-heimdall
Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

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