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

Explore alternative documentation for BottomSheet Header component. #34339

Conversation

dcalhoun
Copy link
Member

Description

Attempt to increase focus of documentation via:

  • Reduce size of example.
  • Remove empty sections.
  • Use declarative statements.
  • Mimic existing documentation, e.g. BottomSheet Navigation.

How has this been tested?

Viewed rendering on GitHub.

Screenshots

n/a

Types of changes

Documentation

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

Leverage short, declarative statements when possible.
@dcalhoun dcalhoun force-pushed the rnmobile/add/bottom-sheet-header-documentation branch from 9f62347 to 5029037 Compare August 26, 2021 22:01
@enejb
Copy link
Contributor

enejb commented Aug 26, 2021

I like the new documentation.
I think is nice and direct. Thanks.

Copy link
Contributor

@enejb enejb left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. Merge away!

@enejb enejb merged commit a716349 into rnmobile/add/bottom-sheet-header Aug 26, 2021
@enejb enejb deleted the rnmobile/add/bottom-sheet-header-documentation branch August 26, 2021 22:39
@annezazu annezazu added [Type] Enhancement A suggestion for improvement. developer-docs labels Aug 31, 2021
enejb added a commit that referenced this pull request Sep 7, 2021
* Add new Header bottomSheet component

* Include the new Header component in buttomSheet

* Update NavigationHeader to use the new Header component for backwards compatibility

* Update all instances of NavigationHeader with Header

* Update BottomSheet Header documentation to reduce its size (#34339)

Leverage short, declarative statements when possible.

* Move Header to NavBar

* Update usage from Header to NavBar

* Remove the NavigationHeader component

* Fix space in the styles

Co-authored-by: David Calhoun <438664+dcalhoun@users.noreply.github.com>
enejb pushed a commit that referenced this pull request Sep 7, 2021
Leverage short, declarative statements when possible.
@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Nov 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants