Skip to content

Documentation link audit: fix dead/stale targets and remove duplicated README sections #232

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Documentation link audit: fix dead/stale targets and remove duplicated README sections #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
564153f
Initial plan
Copilot Jun 2, 2026
129aaed
Update docs links and navigation targets
Copilot Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 2 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,28 +132,5 @@ The library provides Python wrappers for all Chrome DevTools Protocol domains:
- **Security**: Security-related information
- And many more...

For complete API documentation, visit [py-cdp.readthedocs.io](https://py-cdp.readthedocs.io).

### Type System

All CDP types, commands, and events are fully typed with Python type hints, providing:
- IDE autocomplete support
- Static type checking with mypy
- Clear API contracts
- Inline documentation

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
- How to report bugs and request features
- Development setup and workflow
- Coding standards and testing requirements
- Pull request process

For questions or discussions, feel free to open an issue on GitHub.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

<a href="https://www.hyperiongray.com/?pk_campaign=github&pk_kwd=pycdp"><img alt="define hyperion gray" width="500px" src="https://hyperiongray.s3.amazonaws.com/define-hg.svg"></a>
All CDP types, commands, and events are fully typed with Python type hints for
IDE autocomplete, static type checking, and clear API contracts.
Comment on lines +135 to +136
Copy link
Copy Markdown

@gcassist gcassist Bot Jun 2, 2026

Choose a reason for hiding this comment

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

medium

The Hyperion Gray branding logo and link were removed during the cleanup of the tail sections. Since this repository is maintained under the Hyperion Gray organization, the branding logo should be retained at the end of the README.

Suggested change
All CDP types, commands, and events are fully typed with Python type hints for
IDE autocomplete, static type checking, and clear API contracts.
All CDP types, commands, and events are fully typed with Python type hints for
IDE autocomplete, static type checking, and clear API contracts.
<a href="https://www.hyperiongray.com/?pk_campaign=github&pk_kwd=pycdp"><img alt="define hyperion gray" width="500px" src="https://hyperiongray.s3.amazonaws.com/define-hg.svg"></a>

2 changes: 1 addition & 1 deletion docs/develop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ step is required in that scenario.

The repository uses `Poetry <https://python-poetry.org/>`_ to manage dependencies. Once
you have Poetry installed, use this command to create a new virtual environment and
install PyCDP and its dependencies (including dev dependencies0 in it.
install PyCDP and its dependencies (including dev dependencies) in it.

::

Expand Down
8 changes: 1 addition & 7 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Python wrappers for Chrome DevTools Protocol (CDP).

overview
getting_started
connection
browser_control
api
develop
changelog
Expand All @@ -22,9 +22,3 @@ Indices

* :ref:`genindex`
* :ref:`modindex`
Comment on lines 23 to 24
Copy link
Copy Markdown

@gcassist gcassist Bot Jun 2, 2026

Choose a reason for hiding this comment

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

medium

The Hyperion Gray branding logo was removed from the documentation index page. It should be retained to maintain consistent branding for the repository's documentation.

Suggested change
* :ref:`genindex`
* :ref:`modindex`
* :ref:`genindex`
* :ref:`modindex`
.. image:: https://hyperiongray.s3.amazonaws.com/define-hg.svg
:target: https://www.hyperiongray.com/?pk_campaign=github&pk_kwd=pycdp
:alt: define hyperiongray
:width: 400px



.. image:: https://hyperiongray.s3.amazonaws.com/define-hg.svg
:target: https://www.hyperiongray.com/?pk_campaign=github&pk_kwd=pycdp
:alt: define hyperiongray
:width: 400px
10 changes: 3 additions & 7 deletions docs/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,9 @@ wrappers, this project makes it easier and faster to write CDP client code.
this, providing Playwright-style helpers for navigation, element interaction,
screenshots, and more. See :doc:`browser_control` for details.

**This package provides Chrome DevTools Protocol r678025.** Download a compatible
Chrome package:

* `Linux <https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/678025/chrome-linux.zip>`_
* `Mac <https://storage.googleapis.com/chromium-browser-snapshots/Mac/678025/chrome-mac.zip>`_
* `Windows 32-bit <https://storage.googleapis.com/chromium-browser-snapshots/Win/678025/chrome-win.zip>`_
* `Windows 64-bit <https://storage.googleapis.com/chromium-browser-snapshots/Win_x64/678025/chrome-win.zip>`_
**This package provides Chrome DevTools Protocol r678025.** For a current,
maintained way to download Chrome/Chromium builds, use
`Chrome for Testing <https://googlechromelabs.github.io/chrome-for-testing/>`_.
Comment on lines +33 to +35
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Jun 2, 2026

Choose a reason for hiding this comment

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

medium

Chrome for Testing only provides Chrome/Chromium builds starting from version 113 (released in 2023). However, this package is specified to target Chrome DevTools Protocol r678025 (which corresponds to a much older Chromium version, around v76/v77 from 2019). Using a modern Chrome version with a client generated for r678025 may lead to protocol mismatches or runtime errors due to deprecated or changed APIs. It would be helpful to add a brief note warning users about this potential version discrepancy.


**Install from PyPI (requires Python ≥3.8):**

Expand Down