Skip to content
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 11 commits into from
Feb 1, 2023

Conversation

Simek
Copy link
Collaborator

@Simek Simek commented Jan 30, 2023

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

Screenshot 2023-01-30 at 18 02 52

Checklist

[docs] APISection: allow organizing content in custom sections
@linear
Copy link

linear bot commented Jan 30, 2023

ENG-6985 Notifications

@expo-bot expo-bot added the bot: suggestions ExpoBot has some suggestions label Jan 30, 2023
@expo-bot 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 Simek marked this pull request as ready for review January 30, 2023 17:40
Copy link
Member

@amandeepmittal amandeepmittal left a 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!

@Simek Simek merged commit 07ffa84 into main Feb 1, 2023
@Simek Simek deleted the @simek/notification-autogenerate-docs branch February 1, 2023 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: passed checks ExpoBot has nothing to complain about
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants