docs: api overview page

Author: mdjastrzebski

website/docs/API.md

@@ -0,0 +1,20 @@
+---
+id: api
+title: API Overview
+---
+
+React Native Testing Library consists of following APIs:
+
+- [`render` function](render) - render your UI components for testing purposes
+- [`screen` object](screen) - access rendered UI:
+  - [Queries](queries) - find relevant components by various predicates: role, text, test ids, etc
+  - Lifecycle methods: [`rerender`](screen#rerender), [`unmount`](screen#unmount)
+  - Helpers: [`debug`](screen#debug), [`toJSON`](screen#tojson), [`root`](screen#root)
+- [Jest matchers](jest-matchers) - validate assumptions about your UI
+- [User Event](user-event) - simulate common user interactions like [`press`](user-event#press) or [`type`](user-event#type) in a realistic way
+- [Fire Event](fire-event) - simulate any component event in a simplified way
+- [Other APIs](other):
+  - [Async utils](other#async-utilities): `findBy*` queries, `wait`, `waitForElementToBeRemoved`
+  - [Configuration](other#configuration): `configure`, `resetToDefaults`
+  - [Accessibility](other#accessibility): `isHiddenFromAccessibility`
+  - [Other](other#other-helpers): `within`, `act`, `cleanup`

website/docs/FireEvent.md

@@ -7,8 +7,8 @@ title: Fire Event
 function fireEvent(
   element: ReactTestInstance,
   eventName: string,
-  ...data: Array<any>
-): void
+  ...data: unknown[],
+): void;
 ```
 
 :::note
@@ -163,4 +163,3 @@ fireEvent.scroll(screen.getByText('scroll-view'), eventData);
 Prefer using [`user.scrollTo`](./UserEvent.md#scrollto) over `fireEvent.scroll` for `ScrollView`, `FlatList`, and `SectionList` components. User Event provides a more realistic event simulation based on React Native runtime behavior.
 
 :::
-

website/docs/OtherAPIs.md

@@ -199,9 +199,7 @@ $ RNTL_SKIP_AUTO_DETECT_FAKE_TIMERS=true jest
 ### `isHiddenFromAccessibility`
 
 ```ts
-function isHiddenFromAccessibility(
-  element: ReactTestInstance | null
-): boolean {}
+function isHiddenFromAccessibility(element: ReactTestInstance | null): boolean {}
 ```
 
 Also available as `isInaccessible()` alias for React Testing Library compatibility.
@@ -226,7 +224,7 @@ Specifying `accessible={false}`, `accessiblityRole="none"`, or `importantForAcce
 
 ## Other helpers
 
-### `within`, `getQueriesForElement`
+### `within`, `getQueriesForElement` {#within}
 
 ```jsx
 function within(element: ReactTestInstance): Queries {}
@@ -298,4 +296,4 @@ describe('when logged in', () => {
 });
 ```
 
-Failing to call `cleanup` when you've called `render` could result in a memory leak and tests which are not "idempotent" (which can lead to difficult to debug errors in your tests).
+Failing to call `cleanup` when you've called `render` could result in a memory leak and tests which are not "idempotent" (which can lead to difficult to debug errors in your tests).

website/docs/Queries.md

@@ -1,6 +1,6 @@
 ---
 id: queries
-title: Queries API
+title: Queries
 ---
 
 Queries are one of the main building blocks for the React Native Testing Library. They enable you to find relevant elements in the element tree, which represents the your application's user interface when running under tests.

website/docs/Render.md

@@ -1,6 +1,6 @@
 ---
 id: render
-title: Render API
+title: Render function
 ---
 
 ```jsx

website/docs/Screen.md

@@ -1,6 +1,6 @@
 ---
 id: screen
-title: Screen API
+title: Screen object
 ---
 
 ```ts
@@ -31,7 +31,7 @@ See [Queries](./Queries.md) for a complete list.
 import { render, screen } from '@testing-library/react-native';
 
 render(<MyComponent />);
-const buttonStart = screen.getByRole('button', { name: 'start' })
+const buttonStart = screen.getByRole('button', { name: 'start' });
 ```
 
 ### `rerender`
@@ -154,4 +154,3 @@ Returns the rendered [composite root element](testing-env#host-and-composite-com
 :::note
 This API has been previously named `container` for compatibility with [React Testing Library](https://testing-library.com/docs/react-testing-library/other#container-1). However, despite the same name, the actual behavior has been significantly different; hence, we decided to change the name to `UNSAFE_root`.
 :::
-

website/docs/UserEvent.md

@@ -1,6 +1,6 @@
 ---
 id: user-event
-title: User Event
+title: User Event interactions
 ---
 
 :::note

website/sidebars.js

@@ -2,6 +2,7 @@ module.exports = {
   docs: {
     Introduction: ['getting-started'],
     'API Reference': [
+      'api',
       'render',
       'screen',
       'queries',