Skip to content

docs(0.8): backport minP / repetitionPenalty docs to v0.8.x#1111

Merged
msluszniak merged 3 commits intomainfrom
@ms/docs-0.8.4-versioned
Apr 29, 2026
Merged

docs(0.8): backport minP / repetitionPenalty docs to v0.8.x#1111
msluszniak merged 3 commits intomainfrom
@ms/docs-0.8.4-versioned

Conversation

@msluszniak
Copy link
Copy Markdown
Member

@msluszniak msluszniak commented Apr 29, 2026

Description

Backports the sampling and multimodal-rename doc edits from #1099 into the v0.8.x useLLM.md and LLMModule.md pages, plus a JSDoc fence fix on useInstanceSegmentation.ts. New minP / repetitionPenalty / topP field names are rendered as plain inline code rather than anchor links, since the v0.8.x GenerationConfig.md snapshot doesn't have those entries.

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

yarn build in docs/.

Screenshots

Related issues

Follow-up to #1108 / v0.8.4.

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 Apr 29, 2026
@msluszniak msluszniak marked this pull request as draft April 29, 2026 12:37
@msluszniak msluszniak added the documentation Improvements or additions to documentation label Apr 29, 2026
The @example block on useInstanceSegmentation contains a JSX expression
inside a ```ts fence, which trips the @typescript-eslint parser when
the generated markdown is staged. Switch the fence to tsx so the lint
hook on regenerated api-reference snapshots passes.
Backport the sampling and multimodal-rename doc edits from #1099 into
the v0.8.x useLLM.md and LLMModule.md pages.
@msluszniak msluszniak force-pushed the @ms/docs-0.8.4-versioned branch from f54a911 to 27e1bed Compare April 29, 2026 12:39
@msluszniak msluszniak changed the title docs(0.8): refresh versioned-0.8.x docs for v0.8.4 docs(0.8): backport minP / repetitionPenalty docs to v0.8.x Apr 29, 2026
The minP / repetitionPenalty fields don't exist in the v0.8.x
GenerationConfig.md snapshot, so the anchor links broke the docs
build. Render the field names as plain inline code instead.
@msluszniak msluszniak marked this pull request as ready for review April 29, 2026 12:53
Copy link
Copy Markdown
Contributor

@NorbertKlockiewicz NorbertKlockiewicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@msluszniak msluszniak merged commit c11dbad into main Apr 29, 2026
5 checks passed
@msluszniak msluszniak deleted the @ms/docs-0.8.4-versioned branch April 29, 2026 13:27
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