[notifications] autogenerate package documentation #21002
Merged
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).