Skip to content

docs(readme): streamline LFM2.5 quickstart for Expo#1171

Merged
msluszniak merged 2 commits into
mainfrom
@ms/readme-quickstart-cleanup
May 22, 2026
Merged

docs(readme): streamline LFM2.5 quickstart for Expo#1171
msluszniak merged 2 commits into
mainfrom
@ms/readme-quickstart-cleanup

Conversation

@msluszniak
Copy link
Copy Markdown
Member

Description

Tightens the LFM2.5 quickstart in the root README and all five translated readmes:

  • Flags the quickstart as Expo-targeted and links bare React Native users to the Getting Started guide instead of duplicating the bare install steps inline.
  • Drops the react-native-executorch-bare-resource-fetcher / @dr.pogodin/react-native-fs / @kesha-antonov/react-native-background-downloader lines from the install snippet now that the bare path lives in the docs.
  • Switches the sample to the model-registry accessor (models.llm.lfm2_5_1_2b_instruct()), matching the apps and the new MODEL_REGISTRY flow added in feat(constants)!: switch URLs to v0.9.0 layout + add MODEL_REGISTRY #1148.
  • Normalizes yarn <ios|android> placeholders — no spaces inside the angle brackets.

Introduces a breaking change?

  • Yes
  • No

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

Docs-only change. Render the affected readmes on GitHub and confirm:

  • Quickstart heading is followed by the Expo / bare-RN doc-link sentence.
  • Install block lists only the Expo fetcher trio.
  • Code sample imports models and calls models.llm.lfm2_5_1_2b_instruct().
  • No < ios | android > (with spaces) remains.

Screenshots

N/A

Related issues

N/A

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

The translated readmes carry through the same edits with the disclaimer + doc link translated into each language; the docs URL is shared across all of them.

- Note that the quickstart targets Expo and link bare RN users to the
  Getting Started guide.
- Drop the bare-fetcher install commands from the install snippet now
  that the guide handles that path.
- Switch the sample to the model-registry accessor
  (models.llm.lfm2_5_1_2b_instruct()).
- Normalize "yarn <ios|android>" placeholders (no inner spaces).

Applies to the root README and all readmes/ translations.
@msluszniak msluszniak self-assigned this May 22, 2026
@msluszniak msluszniak added the documentation Improvements or additions to documentation label May 22, 2026
@msluszniak msluszniak requested a review from chmjkb May 22, 2026 09:19
@msluszniak msluszniak requested a review from barhanc May 22, 2026 10:26
@msluszniak msluszniak merged commit 032c61d into main May 22, 2026
3 checks passed
@msluszniak msluszniak deleted the @ms/readme-quickstart-cleanup branch May 22, 2026 10:43
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

Development

Successfully merging this pull request may close these issues.

2 participants