Skip to content

[docs] Reorganise Debugging docs#3693

Merged
huntie merged 1 commit intofacebook:mainfrom
huntie:debugging-guide-updates-2
Apr 21, 2023
Merged

[docs] Reorganise Debugging docs#3693
huntie merged 1 commit intofacebook:mainfrom
huntie:debugging-guide-updates-2

Conversation

@huntie
Copy link
Copy Markdown
Member

@huntie huntie commented Apr 19, 2023 •
edited
Loading

Summary

This is an opinionated reorganisation of the current Debugging guide into 3 subpages.

image

  • Debugging Basics — remains the catch-all for introducing our debugging tools/workflow. Remains /docs/debugging.
  • React Developer Tools — migrates the React DevTools + Debugging Application State sections.
  • Native Debugging — our (sparse) existing sections on debugging native code. ⬅️ This reveals obvious space for improvement, which I'm looking to contribute in the near future.

Other changes

  • Converts quoted Markdown "Note" sections as either :::note or :::info blocks.
  • Unifies and condenses extra sections under Chrome DevTools (pictured).

Screenshot 2023-04-19 at 18 06 23

  • Removes outdated 0.62 disclaimer for React DevTools.

image

Test Plan

  • Visit preview website and navigate to /docs/next/debugging.
/docs/next/debugging /docs/next/react-devtools /docs/next/native-debugging
image image image

@huntie huntie changed the title [docs] Update in-app dev menu instructions, and consistently name as … [docs] Reorganise Debugging docs Apr 19, 2023
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 19, 2023 •
edited
Loading

✅ Deploy Preview for react-native ready!

Name Link
🔨 Latest commit 8d362b7
🔍 Latest deploy log https://app.netlify.com/sites/react-native/deploys/64412f22fa9d1e000896d815
😎 Deploy Preview https://deploy-preview-3693--react-native.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@huntie huntie force-pushed the debugging-guide-updates-2 branch from 8609217 to e7811d2 Compare April 19, 2023 17:16
@huntie huntie force-pushed the debugging-guide-updates-2 branch from e7811d2 to 8d362b7 Compare April 20, 2023 12:25
@huntie huntie marked this pull request as ready for review April 20, 2023 12:25
@huntie huntie requested review from cipolleschi and cortinico April 20, 2023 14:27
cortinico
cortinico approved these changes Apr 21, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@cortinico cortinico left a comment

Choose a reason for hiding this comment

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

Great cleanup

@huntie huntie merged commit 1b23012 into facebook:main Apr 21, 2023
@huntie huntie deleted the debugging-guide-updates-2 branch April 21, 2023 15:10
@Simek Simek mentioned this pull request Oct 24, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cortinico cortinico cortinico approved these changes

@cipolleschi cipolleschi Awaiting requested review from cipolleschi

Assignees

No one assigned

Labels

CLA Signed p: Facebook Partner

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@huntie @cortinico @facebook-github-bot