Skip to content

Update Smart Intent README docs#64

Open
thepluck wants to merge 1 commit into
mainfrom
update-smart-intent-readme-docs
Open

Update Smart Intent README docs#64
thepluck wants to merge 1 commit into
mainfrom
update-smart-intent-readme-docs

Conversation

@thepluck

Copy link
Copy Markdown
Member

Summary

  • Replace the default Foundry README with Smart Intent protocol documentation.
  • Add linked references to generated docs for core contracts, structs, hooks, and functions.
  • Document router flow, hook families, base hooks, deployment scripts, and local development commands.

Impact

This gives readers a protocol-oriented entry point from the repository root while keeping detailed API references in the generated docs tree.

Validation

  • git diff --check
  • Verified local README Markdown link targets exist
  • Checked README avoids local report references and audit-style wording

Notes

Only README.md is included in this PR. Existing local edits to .gitignore and foundry.toml were left unstaged.

@thepluck thepluck marked this pull request as ready for review June 17, 2026 09:50
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