docs: Add AGENTS.md and refresh SDK docs#270
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughIntroduces ChangesAgent Docs Consolidation and README Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
michaelsmueller
force-pushed
the
offp-530
branch
from
efc19ea to
734a2d6
Compare
michaelsmueller
force-pushed
the
offp-530
branch
from
734a2d6 to
687464d
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
AGENTS.md (1)
29-38: ⚡ Quick winSpecify language identifier for the code block.
The directory structure code block at line 29 is missing a language identifier. While tree structures don't have a strict language, adding one (e.g.,
tree,text, orbash) helps linters and documentation renderers.📝 Proposed fix
## Structure -``` +```tree src/ ├── abis/ # Contract ABI JSON — source of truth, committed ├── addresses/ # Deployed addresses per project: {network}-{env}.ts ├── helpers/ # Unsigned/signed transaction serialisation utils ├── typechain/ # Generated ethers v5 typings — gitignored, built from abis/ └── index.ts # Public API — contract factories, addresses, utils scripts/build-typechain.js # ABI -> typechain codegen config.json # typechain generation config -``` +```🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` around lines 29 - 38, The code block displaying the directory structure starting with src/ and containing abis/, addresses/, helpers/, typechain/, and index.ts is missing a language identifier on its opening fence. Update the opening triple backticks from ``` to ```tree to properly specify the code block format, which will help linters and documentation renderers correctly process the tree structure.README.md (1)
211-211: ⚡ Quick winClarify the phrasing "A different Offchain dev approves the deployment."
Line 211 uses the phrasing "A different Offchain dev," which is grammatically awkward. The term "Offchain" may also need verification for casing/hyphenation consistency (e.g., "off-chain" or "offchain"). Depending on your team's canonical terminology, consider rephrasing to "An offchain developer from a different team approves" or similar for clarity.
📝 Suggested rephrase
-4. A different Offchain dev approves the deployment. +4. An offchain developer from a different team approves the deployment.Adjust the term "offchain" to match your codebase's canonical naming (e.g., "off-chain" if that is preferred).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 211, On line 211 of README.md, rephrase the awkward phrasing "A different Offchain dev approves the deployment" to be more grammatically clear, such as "An offchain developer from a different team approves the deployment." Additionally, verify the canonical casing and hyphenation of the term "offchain" by checking how it is used elsewhere in the README and codebase (it may be "offchain", "off-chain", or "Offchain") and ensure consistency with that standard throughout the sentence.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@AGENTS.md`:
- Around line 29-38: The code block displaying the directory structure starting
with src/ and containing abis/, addresses/, helpers/, typechain/, and index.ts
is missing a language identifier on its opening fence. Update the opening triple
backticks from ``` to ```tree to properly specify the code block format, which
will help linters and documentation renderers correctly process the tree
structure.
In `@README.md`:
- Line 211: On line 211 of README.md, rephrase the awkward phrasing "A different
Offchain dev approves the deployment" to be more grammatically clear, such as
"An offchain developer from a different team approves the deployment."
Additionally, verify the canonical casing and hyphenation of the term "offchain"
by checking how it is used elsewhere in the README and codebase (it may be
"offchain", "off-chain", or "Offchain") and ensure consistency with that
standard throughout the sentence.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: cf9843ad-fe12-4238-b1db-b65ed4a1a2b2
📒 Files selected for processing (6)
.cursorrules.gitignoreAGENTS.mdCLAUDE.mdGEMINI.mdREADME.md
✅ Files skipped from review due to trivial changes (3)
- .cursorrules
- CLAUDE.md
- GEMINI.md
🚧 Files skipped from review as they are similar to previous changes (1)
- .gitignore
michaelsmueller
force-pushed
the
offp-530
branch
from
687464d to
3b0c7f4
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (3)
AGENTS.md (3)
29-29: 💤 Low valueAdd language identifier to fenced code block.
The Structure code block should specify a language (e.g.,
bash` ortxt`) to comply with markdown best practices.Fix code fence
## Structure -``` +```bash src/🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` at line 29, The fenced code block in AGENTS.md at line 29 is missing a language identifier on the opening fence. Modify the opening triple backticks to include a language identifier (such as "bash" or "txt") to comply with markdown best practices. Change the opening fence from ``` to ```bash (or the appropriate language) to properly indicate the code block type for the file structure content that follows.Source: Linters/SAST tools
47-47: 💤 Low valueStandardize "off-chain" spelling across documentation.
Both AGENTS.md and README.md use "Offchain dev" where the standard English spelling is "off-chain" (hyphenated) in technical/blockchain contexts.
AGENTS.md#L47: Change "A different Offchain dev approves the deployment." to use "off-chain dev".README.md#L211: Change "A different Offchain dev approves the deployment." to use "off-chain dev".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` at line 47, Standardize the spelling of "Offchain dev" to "off-chain dev" (with hyphenation) across both documentation files. In AGENTS.md at line 47, change "A *different* Offchain dev approves the deployment." to use "off-chain dev". In README.md at line 211, change "A different Offchain dev approves the deployment." to use "off-chain dev". This ensures consistent technical spelling across all documentation in alignment with standard blockchain terminology conventions.Source: Linters/SAST tools
46-46: 💤 Low valueEnsure consistent GitHub capitalization.
Line 46 should use "GitHub" (capital "H") when referring to the platform/service.
Fix capitalization
-2. Create a GitHub Release tagged `vX.Y.Z` (must match `package.json`). -3. The **Publish Release** workflow (`.github/workflows/release.yaml`) runs in the `npm` environment. +2. Create a GitHub Release tagged `vX.Y.Z` (must match `package.json`). +3. The **Publish Release** workflow (`.GitHub/workflows/release.yaml`) runs in the `npm` environment.Note: The
.github/directory is a GitHub convention, so the path itself should use lowercase.github/, but any prose reference to the platform should be "GitHub".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` at line 46, In the AGENTS.md file at line 46, ensure consistent capitalization of the GitHub platform name. When referring to the GitHub platform or service in prose (not the `.github/` directory path which should remain lowercase), use "GitHub" with a capital "H". Review the line containing the Publish Release workflow reference and update any prose references to the platform from lowercase "github" to "GitHub" while keeping the `.github/workflows/release.yaml` file path in lowercase.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@AGENTS.md`:
- Line 29: The fenced code block in AGENTS.md at line 29 is missing a language
identifier on the opening fence. Modify the opening triple backticks to include
a language identifier (such as "bash" or "txt") to comply with markdown best
practices. Change the opening fence from ``` to ```bash (or the appropriate
language) to properly indicate the code block type for the file structure
content that follows.
- Line 47: Standardize the spelling of "Offchain dev" to "off-chain dev" (with
hyphenation) across both documentation files. In AGENTS.md at line 47, change "A
*different* Offchain dev approves the deployment." to use "off-chain dev". In
README.md at line 211, change "A different Offchain dev approves the
deployment." to use "off-chain dev". This ensures consistent technical spelling
across all documentation in alignment with standard blockchain terminology
conventions.
- Line 46: In the AGENTS.md file at line 46, ensure consistent capitalization of
the GitHub platform name. When referring to the GitHub platform or service in
prose (not the `.github/` directory path which should remain lowercase), use
"GitHub" with a capital "H". Review the line containing the Publish Release
workflow reference and update any prose references to the platform from
lowercase "github" to "GitHub" while keeping the
`.github/workflows/release.yaml` file path in lowercase.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: dd6dc966-be4c-465c-9829-0540aa442175
📒 Files selected for processing (7)
.cursorrules.gitignoreAGENTS.mdCLAUDE.mdGEMINI.mdREADME.mdpackage.json
✅ Files skipped from review due to trivial changes (4)
- CLAUDE.md
- .cursorrules
- GEMINI.md
- .gitignore
garlab
left a comment
garlab
left a comment
There was a problem hiding this comment.
Looks good, consider comments
michaelsmueller
force-pushed
the
offp-530
branch
from
3b0c7f4 to
ed62b9a
Compare
michaelsmueller
force-pushed
the
offp-530
branch
from
ed62b9a to
48cbd5f
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 29-38: The code fence in the directory tree listing at lines 29-38
in AGENTS.md is missing a language tag specification. Add the language tag
"text" to the opening fence delimiter to comply with markdown linting rules and
resolve the MD040 warning. Change the opening triple backticks followed by a
newline to triple backticks followed by "text" and then a newline.
In `@README.md`:
- Line 218: Correct the typo in the word "infomration" by changing it to
"information" in the sentence about technical resources for Maple Protocol. This
is a straightforward spelling correction where letters are out of order.
- Around line 55-58: The import statement in the README example is incomplete.
The code snippet uses `addresses['mainnet-prod'].MapleToken` but only imports
`mapleGlobals` from '`@maplelabs/maple-js`', leaving the `addresses` object
undefined. Update the import statement to destructure both `mapleGlobals` and
`addresses` from the '`@maplelabs/maple-js`' package so the example code will run
as written.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6910a55e-7c13-459b-875e-8228b96986d2
📒 Files selected for processing (7)
.cursorrules.gitignoreAGENTS.mdCLAUDE.mdGEMINI.mdREADME.mdpackage.json
✅ Files skipped from review due to trivial changes (4)
- CLAUDE.md
- GEMINI.md
- .gitignore
- .cursorrules
🚧 Files skipped from review as they are similar to previous changes (1)
- package.json
|
@coderabbitai resolve |
✅ Action performedComments resolved. Approval is disabled; enable |
2 participants
Problem
maple-jshad no agent/dev context files (unlike the rest of the workspace), and the README's address examples were stale — they usedaddresses.mainnet.X, but the exportedaddressesobject is keyed by project, not network.engines.nodealso still said>=22while the rest of the stack has moved to Node 24.Solution
AGENTS.mdas canonical context per the Maple workspace convention, plusCLAUDE.md(@AGENTS.md) and.cursorrules/GEMINI.mdsymlinks; gitignore the.localvariants.README.md: add Development and Releasing sections (the latter documents the npm OIDC trusted-publishing flow), fix the project-keyed address examples, addsepolia-prod, and note Base Mainnet is deprecated.engines.nodeto>=24.14.1to match the stack: hub runsnode:24in prod, every active.nvmrcpins24.14.1, andmaple-webappalready declares>=24.14.1.Summary by CodeRabbit
Documentation
mainnet-prod,sepolia-dev,base-mainnet-prodmarked deprecated) and updated connection examples accordingly.Chores