Commit 30f50eb
docs(agentic): add getting-started for first-time recipe runs (#29426)
## **Description**
Adds `scripts/perps/agentic/GETTING_STARTED.md` — onboarding doc for
devs who already have a daily simulator + Metro running and want to try
the agentic recipe toolkit without breaking their setup.
Headline is port + simulator isolation: pick (or create) a dedicated
simulator, set `IOS_SIMULATOR` + a non-8081 `WATCHER_PORT` in `.js.env`,
copy the wallet fixture, run `yarn a:setup:ios`, verify with `yarn
a:status`, then run `provider-smoke.json`. Also documents the `yarn a:*`
family and links to `perps-agentic-system-design.md`,
`perps-agentic-feedback-loop.md`, `perps-agentic-scripts-quickref.md`,
and ADR 0058.
## **Changelog**
CHANGELOG entry: null
## **Related issues**
Fixes:
## **Manual testing steps**
```gherkin
Feature: agentic getting-started doc
Scenario: developer follows the doc on a fresh side simulator
Given a developer has their dev simulator + Metro running on 8081
And they have never run an agentic recipe before
When they follow the steps in scripts/perps/agentic/GETTING_STARTED.md
Then yarn a:setup:ios completes without touching the dev simulator or 8081
And yarn a:status returns a route + selected account
And validate-recipe.sh teams/perps/recipes/provider-smoke.json passes
```
## **Screenshots/Recordings**
N/A — docs only.
### **Before**
No onboarding entry point for the agentic toolkit.
### **After**
`scripts/perps/agentic/GETTING_STARTED.md` walks a first-time user from
zero to a passing recipe in ~5 commands.
## **Pre-merge author checklist**
- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [ ] I've included tests if applicable
- [ ] I've documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I've applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.
#### Performance checks (if applicable)
N/A — docs-only change.
## **Pre-merge reviewer checklist**
- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Low Risk**
> Low risk: documentation-only change with no runtime or build logic
modifications.
>
> **Overview**
> Adds `scripts/perps/agentic/GETTING_STARTED.md` to onboard developers
to the agentic recipe toolkit, emphasizing **isolated simulator +
non-8081 Metro port** setup via `.js.env` (`IOS_SIMULATOR`,
`WATCHER_PORT`).
>
> Documents creating a local wallet fixture, running `yarn a:setup:ios`,
validating wiring via `yarn a:status`, and executing a first smoke
recipe, plus a quick reference to the `yarn a:*` script family and links
to deeper design docs.
>
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
6f46b14. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
Co-authored-by: Nick Gambino <nicholas.gambino@consensys.net>1 parent e7ec5b0 commit 30f50eb
1 file changed
Lines changed: 101 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
0 commit comments