-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[notifications] autogenerate package documentation #21002
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[docs] APISection: allow organizing content in custom sections
Co-authored-by: Expo Bot <[email protected]>
expo-bot
added
bot: passed checks
ExpoBot has nothing to complain about
and removed
bot: suggestions
ExpoBot has some suggestions
labels
Jan 30, 2023
Simek
requested review from
amandeepmittal,
kbrandwijk and
tsapeta
as code owners
January 30, 2023 17:40
amandeepmittal
approved these changes
Jan 31, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small suggestion but it shouldn't be blocking this PR (and I think its unrelated to the changes of this PR).
Thanks for moving these docs to be autogenerated!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
Fixes ENG-6985
expo-notifications
is the latest package which left to be migrated to autogenerated docs, let's finally close the migration process.How
As always, the documentation content has been moved to the package source. There were few small type changes (mainly extractions) required for proper docs data extraction by TypeDoc.
Additionally, I need to add new
APISection
feature which allows organizing content (currently method only to be precise) in custom sections, which can be manually ordered and are placed before general API section. This was required to mimic the current structure of the page.I have also updated the API docs section in our contributing guide to address newly added
@header
parameter.Test Plan
The new doc page has been tested by running docs app locally.
Package tests and lint do not yield any errors.
Preview
Checklist
expo prebuild
& EAS Build (eg: updated a module plugin).