Skip to content

Commit e4aba40

Browse files
committed
agent docs
1 parent 4da5967 commit e4aba40

3 files changed

Lines changed: 16 additions & 0 deletions

File tree

agents/build-and-validation.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,23 @@
1010
- Check formatting: `yarn format:check`
1111
- Validate the main package: `yarn validate`
1212
- Build the package: `yarn build`
13+
- Regenerate package docs: `yarn docs:generate`
14+
- Check package docs are in sync: `yarn docs:check`
1315

1416
## Command notes
1517

1618
- `yarn lint` runs ESLint on `src`.
1719
- `yarn validate` runs typecheck, tests, lint, and oxfmt checks for the main package.
1820
- `yarn build` cleans `dist/`, transpiles source with Babel, and emits TypeScript declarations.
1921

22+
## Documentation
23+
24+
- The docs under `website/docs/` are the source of truth. The `docs/api/*.md` files are
25+
generated from them — never edit those by hand.
26+
- After making any documentation changes, run `yarn docs:generate` to regenerate the package
27+
docs, and commit the regenerated files alongside your `website/` edits. `yarn docs:check`
28+
(part of `validate:all`) fails if they are out of sync.
29+
2030
## Repo layout
2131

2232
- `src/`: source code

docs/api/fire-event.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,9 @@ await fireEvent.scroll(screen.getByTestId('scroll-view'), eventData);
166166

167167
### `fireEvent.layout`
168168

169+
> [!NOTE]
170+
> Available since React Native Testing Library 14.1.0.
171+
169172
```tsx
170173
fireEvent.layout: (
171174
instance: TestInstance,

docs/api/user-event.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,9 @@ The sequence of events depends on whether the scroll includes an optional moment
296296

297297
## `accessibilityAction()`
298298

299+
> [!NOTE]
300+
> Available since React Native Testing Library 14.1.0.
301+
299302
```ts
300303
accessibilityAction(
301304
instance: TestInstance,

0 commit comments

Comments
 (0)