debug
debug copied to clipboard
Restructure documents
These changes was done with these focus:
- The readme is compact and easy to navigate through, with links to further information
- New users can quickly feel familiar with the console
- Remote debugging and client integrations can have more detailed instructions (e.g. integrate with Rails)
Main Changes
- Usage section is structured around a 4-step debugging flow
- Debugger activation
- Setting breakpoints
- (Triggering breakpoints - which doesn't need a section)
- Start debugging (commands and intro to console)
- Remote debugging and configuration related content are extracted to dedicated files under
docs- They both have links at the introduction section and their own short sections in the readme
- VSCode and Chrome DevTools also have links to their own sections
- They are still under the remote debugging guide because most users (e.g. Rails users) still needs to know about it to make a successful integration
- VSCode section now has steps dedicated for Rails/web app integration
- Command list is still kept in the readme because console users are still the majority in the community, and they need those commands to get started
- Remote debugging contents are re-organized and extended a bit
I'll document some details in comments.
Can I see the updated doc in HTML? (I want to see on the rendered page)
You can click into my branch and it's the rendered result.
And in general you can visit a PR's branch by clicking its name:
Thank you. I'll review it but now I'm busy so please wait a while.
@ko1 I've rebased it against master and applied some updates. Would you mind giving it a look again?