-
Notifications
You must be signed in to change notification settings - Fork 260
docs: clarify example-specific tasks and native adapter instructions #1905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
St0rmBr3w
commented
Jan 20, 2026
- WORKFLOW.md: Add note clarifying lz:oft:send is a custom task defined in examples/oft/tasks/, not a core SDK task
- native-oft-adapter README: Replace confusing mint instructions with accurate note about native token usage (no minting required)
- WORKFLOW.md: Add note clarifying lz:oft:send is a custom task defined in examples/oft/tasks/, not a core SDK task - native-oft-adapter README: Replace confusing mint instructions with accurate note about native token usage (no minting required)
PR SummaryIntroduces clear deployment guidance and fixes confusing example docs.
Written by Cursor Bugbot for commit 1870046. Configure here. |
…xamples - Add root-level CLAUDE.md, DEBUGGING.md, CHEATSHEET.md guides - Add CLAUDE.md files for all examples explaining their purpose and usage - Add AGENTS.md files for key packages with CI/automation guidance - Update AGENTS.md, README.md with improved documentation - Add changesets for version tracking
Code reviewFound 5 issues:
devtools/examples/oft-composer-library/CLAUDE.md Lines 12 to 27 in d74d228
devtools/examples/oft-evm-solana-move/CLAUDE.md Lines 12 to 31 in d74d228
devtools/examples/oft-solana-composer-library/CLAUDE.md Lines 12 to 27 in d74d228
devtools/examples/oft-tron/CLAUDE.md Lines 12 to 26 in d74d228
Lines 1 to 20 in d74d228
Recommendation: For issues 1-4, either add a clear notice that these are placeholder/scaffold examples (not runnable implementations), or remove the CLAUDE.md files until the examples are implemented. For issue 5, consider restoring the beta warning or adding a clear statement about the repository's stability status. Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
…warning - Remove CLAUDE.md files for examples that only exist locally: - examples/frontend/ - examples/oft-composer-library/ - examples/oft-evm-solana-move/ - examples/oft-solana-composer-library/ - examples/oft-tron/ - Restore beta warning in README.md - Restore original navigation links (DEVELOPMENT.md)