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

RNMobile: Fix links, images, and formatting in documentation #34300

Merged
merged 2 commits into from
Aug 26, 2021

Conversation

guarani
Copy link
Contributor

@guarani guarani commented Aug 25, 2021

Description

This fixes a couple of issues in Native Mobile docs (especially when viewed from the Block Editor Handbook):

  • Some doc links were broken because they used relative paths to files outside of the docs folder, others likely because files had been renamed and links were not updated
  • An image was broken because it didn't use an absolute link but instead used a relative link
  • Code snippets needed to be indented properly
  • Code snippets were missing a language specifier – adding this fixes their formatting, especially in the Block Editor Handbook

How has this been tested?

  • Test changes by viewing the changed files on the latest commit on this branch and verify links, images, and formatting look correct
  • (After merging and waiting 15 minutes for the Block Editor Handbook to sync) Open the Block Editor Handbook to the relevant files changes here and verify all links, images and formatting look correct

Types of changes

  • Documentation updates

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

* Doc links were broken because they used relative paths to files outside of the docs folder
* An image was broken because it didn't use a direct link but instead used a relative link
* Code snippets needed to be indented properly
@guarani guarani added [Type] Developer Documentation Documentation for developers Mobile App - i.e. Android or iOS Native mobile impl of the block editor. (Note: used in scripts, ping mobile folks to change) labels Aug 25, 2021
@guarani guarani marked this pull request as ready for review August 25, 2021 14:16
@guarani guarani requested a review from mchowning August 25, 2021 14:16
Copy link
Contributor

@mchowning mchowning left a comment

Choose a reason for hiding this comment

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

Everything looks good. Thanks for the 🧹 @guarani !

@guarani guarani merged commit 0b9114f into trunk Aug 26, 2021
@guarani guarani deleted the rnmobile/docs/fix-typos-and-broken-links branch August 26, 2021 15:30
@github-actions github-actions bot added this to the Gutenberg 11.5 milestone Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Mobile App - i.e. Android or iOS Native mobile impl of the block editor. (Note: used in scripts, ping mobile folks to change) [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants