Skip to content

Conversation

@msluszniak
Copy link
Member

@msluszniak msluszniak commented Jan 22, 2026

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.
  • Passing number[] in Speech to Text is now not supported anymore.
  • Aligned docs with another breaking change, LLMModule not does not take responseCallback`

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

@msluszniak msluszniak self-assigned this Jan 22, 2026
@msluszniak msluszniak added the documentation Improvements or additions to documentation label Jan 22, 2026
@msluszniak msluszniak marked this pull request as draft January 22, 2026 15:20
@msluszniak

This comment was marked as resolved.

@msluszniak

This comment was marked as resolved.

@msluszniak msluszniak force-pushed the @ms/add-autogenerated-api-to-docs branch from 470528b to 98ccf0b Compare January 23, 2026 17:48
@msluszniak msluszniak linked an issue Jan 26, 2026 that may be closed by this pull request
@msluszniak

This comment was marked as resolved.

@msluszniak

This comment was marked as resolved.

@msluszniak

This comment was marked as resolved.

@msluszniak msluszniak marked this pull request as ready for review January 30, 2026 23:18
@msluszniak msluszniak linked an issue Feb 2, 2026 that may be closed by this pull request
@msluszniak msluszniak requested review from chmjkb and mkopcins and removed request for chmjkb February 2, 2026 11:12
chmjkb

This comment was marked as resolved.

@chmjkb

This comment was marked as resolved.

@msluszniak msluszniak requested a review from chmjkb February 3, 2026 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

3 participants