Add autogenerated API for React Native ExecuTorch documentation #748

msluszniak · 2026-01-22T15:20:11Z

Description

This PR adds auto-generated API into documentation. This is based on typedoc comments in TypeScript code which are also added here. During creating this documentation I caught many smaller errors. They are fixed here as well.

Introduces a breaking change?

Yes
No

This PR remove constant for vertical OCR. All constants that started with VERTICAL_OCR_* are now removed. From now, only OCR_* constants should be used for both OCR and vertical OCR.

Type of change

Bug fix (change which fixes an issue)
New feature (change which adds functionality)
Documentation update (improves or adds clarity to existing documentation)
Other (chores, tests, code style improvements etc.)

Tested on

iOS
Android

Testing instructions

Build documentation from this PR (cd docs & yarn & yarn build & yarn serve)
Check if API of our library is visible in the sidebar to the left (at the very bottom of it)
Then, Scan through the all API Reference and check if all the sections are correctly filled
Check if in the sections with Hooks and TypeScript API all the hand written tables with signatures etc. are removed, now API Reference is a source of truth. You should also check that the links the these section redirects to correct sections. The link themselves are correct (checked in building process), just the site where they pointing might be incorrect.
Check other changed sections of documentation for correctness
Check all the files with code that were changed if the changes are correct.

Please do not review files in directory 06-api-reference, they are generated automatically.
Also you don't need to check any *.md files manually, you can test them all by clicking through the built documentation ;)

Screenshots

Related issues

#772
#752
#746
#612
#410

Checklist

I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have updated the documentation accordingly
My changes generate no new warnings

Additional notes

packages/react-native-executorch/src/errors/ErrorCodes.ts

packages/react-native-executorch/src/types/objectDetection.ts

packages/react-native-executorch/src/types/imageSegmentation.ts

chmjkb

Overall looks good, a couple of thoughts:

Can we add some kind of README to explain how the generation works, etc? Maybe I missed it in this file madness 😅
When i enter the API Reference section, and a specific definiton, both the navbar and the bar on the image disappears, can we fix it?

docs/docs/01-fundamentals/02-loading-models.md

docs/docs/03-hooks/01-natural-language-processing/useLLM.md

docs/docs/03-hooks/01-natural-language-processing/useSpeechToText.md

chmjkb · 2026-02-02T14:21:00Z

docs/docs/03-hooks/01-natural-language-processing/useSpeechToText.md

-
-```typescript
-// Languages supported by whisper (Multilingual)
-type SpeechToTextLanguage =


Sidenote here: Maybe we shoiuld explain what each one of these represents? I feel like this might be confusing for new users (old users too)

docs/docs/03-hooks/01-natural-language-processing/useTextToSpeech.md

chmjkb · 2026-02-03T07:31:48Z

packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts

  public delete(): void {
    this.nativeModule.unload();
  }

+  /**


Maybe we should just delete the number[] already? or agree on a timeline for deleting this

Sure thing, I can remove all the deprecated signatures and add information about this in Breaking Changes section of this PR

chmjkb · 2026-02-03T07:32:11Z

packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts

+   * Runs the decoder of the model. Passing number[] is deprecated.
+   *
+   * @param tokens - The input tokens.


same here with the number param

chmjkb · 2026-02-03T07:33:10Z

packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts

@@ -104,6 +142,14 @@ export class SpeechToTextModule {
    return this.textDecoder.decode(new Uint8Array(transcriptionBytes));
  }

+  /**
+   * Starts a streaming transcription session.
+   * Yields objects with `committed` and `nonCommitted` transcriptions.


maybe we should explain what that actually means

chmjkb · 2026-02-03T07:36:21Z

packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts

+  /**
+   * Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal.
+   *
+   * @param waveform - The input audio waveform as a Float32Array.
+   * @returns A promise resolving to an array of detected speech segments.
+   */


Maybe it would be worth mentionign the sample rate here

packages/react-native-executorch/src/types/tti.ts

chmjkb · 2026-02-03T08:20:27Z

Also, I got a couple of warnings:

[WARNING] The `siteConfig.onBrokenMarkdownLinks` config option is deprecated and will be removed in Docusaurus v4.
Please migrate and move this option to `siteConfig.markdown.hooks.onBrokenMarkdownLinks` instead.
[info] Loaded plugin typedoc-plugin-markdown
[info] Loaded plugin typedoc-docusaurus-theme
/Users/jakubchmura/Desktop/SWM_AI/react-native-executorch/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:82:33 - [warning] The relative path ../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model is not a file and will not be copied to the output directory

82       * See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details.

/Users/jakubchmura/Desktop/SWM_AI/react-native-executorch/packages/react-native-executorch/src/types/llm.ts:73:33 - [warning] The relative path ../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model is not a file and will not be copied to the output directory

73       * See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details.

Co-authored-by: Jakub Chmura <[email protected]>

msluszniak self-assigned this Jan 22, 2026

msluszniak added the documentation Improvements or additions to documentation label Jan 22, 2026

msluszniak marked this pull request as draft January 22, 2026 15:20

This comment was marked as resolved.

Sign in to view

This was linked to issues Jan 22, 2026

Error Handling docs section is in wrong place in doc sidebar #746

Open

Update documentation to enable auto-generation of API Reference #752

Open

msluszniak added 6 commits January 23, 2026 18:03

Add first working autogenerated API

52f159a

Add subsection for generated API

71a9d05

Add support for automatic documentation for the first few hooks

6ec733d

Another hooks handled

9206bea

Update yarn.lock with docusaurus plugin for typedoc

2188c61

Enhance VAD and part of TTS documentation

98ccf0b

msluszniak force-pushed the @ms/add-autogenerated-api-to-docs branch from 470528b to 98ccf0b Compare January 23, 2026 17:48

msluszniak added 4 commits January 24, 2026 13:46

Fix docusaurus.config.js

ac68403

Add another batch of typed docs

9bb82fb

Add new files for better type control

520acc3

Add new typedocs to another modules

81b229b

msluszniak linked an issue Jan 26, 2026 that may be closed by this pull request

Investigate docs code analysis tools #410

Open

msluszniak added 4 commits January 27, 2026 12:03

Add new typed modules

8aadf86

Add changed *.ts files

378038b

Add another batch of module

a8b0a41

Added all of the modules to autogenerated docs

41ebfb4

This comment was marked as resolved.

Sign in to view

msluszniak added 3 commits January 28, 2026 16:34

Organize docs into clean sections

fb8c499

Fix first few pages on our traditional docs

648d3b1

Add another hooks

7d713f1

This comment was marked as resolved.

Sign in to view

Handle another hook section

4bb7c5e

Fix problem with overlapping columns in documentation

7e10c82

msluszniak linked an issue Jan 30, 2026 that may be closed by this pull request

Bump t-rex-ui lib to 1.2.2 #772

Open

msluszniak and others added 9 commits January 30, 2026 21:03

Add all TS Modules

bf7cb74

Completed all API docs

3018035

Bump t-rex version

ec5f7c7

Update FAQ and getting started

b73f138

Merge branch 'main' into @ms/add-autogenerated-api-to-docs

67c2d9d

Fix types in llms

0f14052

Add packages to package.json

52ba2a1

Apply lint fixes

894f841

Add ts to docs

c9f95fb

msluszniak marked this pull request as ready for review January 30, 2026 23:18

msluszniak commented Jan 31, 2026

View reviewed changes

packages/react-native-executorch/src/errors/ErrorCodes.ts Outdated Show resolved Hide resolved

packages/react-native-executorch/src/types/objectDetection.ts Outdated Show resolved Hide resolved

Apply suggestions from code review

d2a421e

msluszniak mentioned this pull request Feb 2, 2026

Model constants grouped by type #612

Open

msluszniak linked an issue Feb 2, 2026 that may be closed by this pull request

Model constants grouped by type #612

Open

Fix one typing in Image Embeddings module

b44ed35

msluszniak requested review from chmjkb and mkopcins and removed request for chmjkb February 2, 2026 11:12

msluszniak removed a link to an issue Feb 2, 2026

Model constants grouped by type #612

Open

msluszniak commented Feb 2, 2026

View reviewed changes

packages/react-native-executorch/src/types/imageSegmentation.ts Outdated Show resolved Hide resolved

chmjkb requested changes Feb 3, 2026

View reviewed changes

msluszniak and others added 4 commits February 3, 2026 10:24

Apply suggestions from code review

adbb0fb

Co-authored-by: Jakub Chmura <[email protected]>

Update packages/react-native-executorch/src/types/imageSegmentation.ts

fa69ba1

Update packages/react-native-executorch/src/types/tti.ts

6829cd7

Co-authored-by: Jakub Chmura <[email protected]>

docs: Apply first batch of suggestions from review

b5d7c22

Add autogenerated API for React Native ExecuTorch documentation #748

Are you sure you want to change the base?

Add autogenerated API for React Native ExecuTorch documentation #748

Conversation

msluszniak commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Introduces a breaking change?

Type of change

Tested on

Testing instructions

Screenshots

Related issues

Checklist

Additional notes

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

chmjkb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chmjkb Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chmjkb Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

msluszniak Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

chmjkb Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

chmjkb Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

chmjkb Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

msluszniak Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chmjkb commented Feb 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

msluszniak commented Jan 22, 2026 •

edited

Loading