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

Correct inconsistencies and errors in Nav Editor docs #34682

Merged
merged 10 commits into from
Sep 21, 2021

Conversation

getdave
Copy link
Contributor

@getdave getdave commented Sep 9, 2021

Description

Following as discussion with @talldan I discovered that there are some inconsistencies in the Nav Editor docs. This PR corrects these. See individual commits for specifics.

How has this been tested?

Screenshots

Types of changes

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).

Copy link
Contributor

@talldan talldan 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 noticing this and updating it 🙇

@getdave getdave marked this pull request as ready for review September 9, 2021 08:55
@getdave
Copy link
Contributor Author

getdave commented Sep 9, 2021

Thanks for noticing this and updating it 🙇

@talldan Just noticed your 👍 here. I made some additional changes. Are you still happy?

@getdave
Copy link
Contributor Author

getdave commented Sep 20, 2021

I haven't forgotten about this...

@Mamaduka
Copy link
Member

The update looks great, Dave.

The "Hooks" section is updated, but I can correct it in follow-up PR today/tomorrow.

The new central hooks are useNavigationEditor and useNavigationBlockEditor. The Layout component itself had many changes and probably won't fit in the small snippet we currently have in docs.

@getdave
Copy link
Contributor Author

getdave commented Sep 21, 2021

Seeking final ✅ on the basis that the scope of this PR is to

  • correct inconsistencies
  • correct errors

🙏 😄

Copy link
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

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

I think this PR is in good shape, and all feedback got addressed 🌟

I'll do a follow-up for hooks tomorrow.

@getdave getdave merged commit 8fca518 into trunk Sep 21, 2021
@getdave getdave deleted the update/nav-editor-docs-with-corrected-info branch September 21, 2021 15:23
@github-actions github-actions bot added this to the Gutenberg 11.6 milestone Sep 21, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants