ChromeDevTools / debugger-protocol-viewer

DevTools Protocol API docs—its domains, methods, and events
https://chromedevtools.github.io/devtools-protocol/
Other
854 stars 173 forks source link

Unclear project repository/site name and description #219

Open Chealer opened 1 month ago

Chealer commented 1 month ago

This repository is named "debugger-protocol-viewer", making it hard to understand that it contains all the source of CDP's website. The repository's description clarifies a lot, but is still far from making it clear that is includes not just the protocol's specification, but documentation about libraries and tools using the protocol:

DevTools Protocol API docs—its domains, methods, and events

I would suggest something like:

Website of Chrome DevTools Protocol, including a specification of CDP methods (commands) and events

What steps will reproduce the problem?

This issue does not report a behavioral defect.

What is the expected result?

This issue does not report a behavioral defect.

What happens instead of that?

This issue does not report a behavioral defect.