Skip to content

Add/block navigation component readme #24882

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.

Sign up for GitHub

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

Jump to bottom
Merged
JustinyAhin merged 4 commits into from
Oct 7, 2020
Merged

Add/block navigation component readme #24882

JustinyAhin merged 4 commits into from
Oct 7, 2020

Conversation

@JustinyAhin
Copy link
Member

@JustinyAhin JustinyAhin commented Aug 28, 2020

Description

Added documentation for the block navigation component (see #22891)

How has this been tested?

N/A, documentation only

Types of changes

Documentation

Checklist:

  • [n/a] My code is tested.
  • [n/a] My code follows the WordPress code style.
  • [n/a] My code follows the accessibility standards.
  • [n/a] 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.

@JustinyAhin JustinyAhin added the [Type] Developer Documentation Documentation for developers label Aug 28, 2020
@JustinyAhin JustinyAhin mentioned this pull request Aug 28, 2020
Closed
youknowriad
youknowriad reviewed Aug 31, 2020
View reviewed changes
packages/block-editor/src/components/block-navigation/README.md Outdated

const MyNavigation = () => <BlockNavigation
onSelect={ onClose }
__experimentalFeatures={ __experimentalFeatures }
Copy link
Contributor

@youknowriad youknowriad Aug 31, 2020

Choose a reason for hiding this comment

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

Should we document experimental things? It seems we shouldn't as they are not ready yet.

Copy link
Member Author

@JustinyAhin JustinyAhin Aug 31, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I think so also.
We can always update this when the feature is more advanced.

That's why I finally removed it from the code sample.

@youknowriad youknowriad requested a review from talldan August 31, 2020 08:26
mkaz
mkaz approved these changes Oct 6, 2020
View reviewed changes
Copy link
Member

@mkaz mkaz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think it's fine to document even if experimental, still value.
Looks good 👍

@JustinyAhin JustinyAhin merged commit b859565 into WordPress:master Oct 7, 2020
@github-actions github-actions bot added this to the Gutenberg 9.2 milestone Oct 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@youknowriad youknowriad youknowriad left review comments

@mkaz mkaz mkaz approved these changes

@ellatrix ellatrix Awaiting requested review from ellatrix

@talldan talldan Awaiting requested review from talldan

Assignees

No one assigned

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 9.2

Development

Successfully merging this pull request may close these issues.

3 participants

@JustinyAhin @mkaz @youknowriad