Commit 04f4a98
authored
docs(agents): add build & run section, list TVOSExample (#3941)
## Description
Adds a `## Build & run` section to `AGENTS.md` covering prerequisites,
the library build (`yarn prepare`), and library TypeScript verification
(`yarn check-types`). Also fixes `## Repository layout tips` so that
`./TVOSExample/` is listed alongside `./FabricExample/`, and updates the
`## Imports` section so TVOSExample is included in the path-alias rule.
The `Verify TypeScript` subsection is intentionally library-only for
now. Per-example tsconfig runs (`FabricExample/`, `TVOSExample/`,
`apps/`) currently surface different sets of pre-existing errors when
invoked directly, and there are no `check-types` scripts in the example
app `package.json` files. Documenting them today would point agents at
red baselines and teach them to ignore TS errors. A short caveat in the
section records this; the example app surface will be documented once
the underlying issues are resolved and a single entry point exists.
## Changes
- Added `## Build & run` section to `AGENTS.md` with three subsections:
- **Prerequisites** — `yarn install`, `yarn submodules`.
- **Build the library** — `yarn prepare` and the resulting outputs under
`./lib/`.
- **Verify TypeScript** — `yarn check-types` plus a caveat explaining
why example-app TS verification is not documented yet.
- Added `./TVOSExample/` bullet to `## Repository layout tips`.
- Added `./TVOSExample/` to the path-alias consumers list under `##
Imports`.
## Test plan
- `yarn check-types` runs cleanly on this branch (the only command newly
documented in the `Verify TypeScript` subsection).
- `yarn prepare` was not re-run as part of this PR (no behavioral change
to the build pipeline; the script is unchanged in `package.json`).
- No source code is modified; the diff is limited to `AGENTS.md`.
## Checklist
- [ ] Included code example that can be used to test this change.
- [ ] For visual changes, included screenshots / GIFs / recordings
documenting the change.
- [ ] For API changes, updated relevant public types.
- [x] Ensured that CI passes1 parent 9e9480d commit 04f4a98
1 file changed
Lines changed: 47 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
25 | 29 | | |
26 | 30 | | |
27 | 31 | | |
28 | 32 | | |
29 | 33 | | |
30 | 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 | + | |
31 | 77 | | |
32 | 78 | | |
33 | 79 | | |
| |||
37 | 83 | | |
38 | 84 | | |
39 | 85 | | |
40 | | - | |
| 86 | + | |
41 | 87 | | |
42 | 88 | | |
43 | 89 | | |
| |||
0 commit comments