Skip to content

docs(useAvoidKeyboard,useKeyboardHeight): auto-generated docs - #394

Merged
hyesungoh merged 8 commits into
mainfrom
new-docgen-branch-31375718343
Aug 10, 2026
Merged

docs(useAvoidKeyboard,useKeyboardHeight): auto-generated docs#394
hyesungoh merged 8 commits into
mainfrom
new-docgen-branch-31375718343

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

This PR includes documentation updates for: useAvoidKeyboard,useKeyboardHeight

@changeset-bot

changeset-bot Bot commented Aug 10, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2dce1d4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov-commenter

codecov-commenter commented Aug 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (cde3670) to head (2dce1d4).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #394   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           58        58           
  Lines         1639      1639           
  Branches       499       499           
=========================================
  Hits          1639      1639           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

Copy link
Copy Markdown
Contributor Author

Size Change: 0 B 🆕

Total Size: 0 B

compressed-size-action

@hyesungoh

Copy link
Copy Markdown
Collaborator

The auto-generated docs in this PR rendered broken Example sections: a literal ```tsx line inside the code block and an empty code block below it.

Cause — the doc template wraps @example content in its own ```tsx fence (assuming raw code, which is the core convention), but the mobile hooks' JSDoc contained markdown fences inside @example. Nested fences → prettier lengthened the outer fence to 4 backticks, the inner fence became literal text, and the leftover closing fence produced an empty block.

Pushed two commits on top of the bot's:

  1. fix(scripts) — the generator now strips fence lines from @example before wrapping, so fenced examples can never break generated docs again.
  2. docs(mobile) — removed fences from all 8 mobile hooks' @example blocks and normalized the 6 remaining hooks to the core JSDoc convention (@description, typed @param/@returns); regenerated the two broken English docs. Verified locally: both pages render with no literal fences and no empty blocks, and the verify-jsdoc / verify-jsdoc-structure gate scripts pass for all 8 files.

Merge order note — this PR now touches useNetworkStatus.ts / useSafeAreaInset.ts / useScrollDirection.ts (JSDoc only), whose statement coverage is below 100% until #396 lands. verify-test will stay red here until #396 merges; after that, re-running the checks turns this green (no rebase needed).

Korean docs are untouched — the translate step needs OPENAI_API_KEY and was skipped both here and in the bot run, so ko/ regeneration remains a follow-up.

@autofix-troubleshooter

Copy link
Copy Markdown

Hi! I'm the autofix logoautofix.ci troubleshooter bot.

It looks like you correctly set up a CI job that uses the autofix.ci GitHub Action, but the autofix.ci GitHub App has not been installed for this repository. This means that autofix.ci unfortunately does not have the permissions to fix this pull request. If you are the repository owner, please install the app and then restart the CI workflow! 😃

@hyesungoh
hyesungoh merged commit 480fba6 into main Aug 10, 2026
12 checks passed
@hyesungoh
hyesungoh deleted the new-docgen-branch-31375718343 branch August 10, 2026 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants