Skip to content

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

Draft
Copilot wants to merge 2 commits into
masterfrom
copilot/fix-documentation
Draft

Documentation link audit: fix dead/stale targets and remove duplicated README sections#232
Copilot wants to merge 2 commits into
masterfrom
copilot/fix-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 2, 2026

This PR performs a focused documentation pass to remove unhelpful link targets and tighten navigation/content consistency. It updates docs where multiple references either pointed to stale destinations or duplicated existing material.

  • Docs navigation

    • Replaced a non-existent toctree target in docs/index.rst:
      • connectionbrowser_control
    • This aligns the docs landing page with files that actually exist and are rendered.
  • Stale external links

    • Replaced obsolete Chromium snapshot ZIP links in docs/overview.rst with the maintained Chrome for Testing landing page:
      • https://googlechromelabs.github.io/chrome-for-testing/
  • README cleanup

    • Removed duplicated tail sections (repeated API/contributing/license content) to avoid multiple paths to the same destination.
    • Kept one concise API/type-system summary.
  • Minor doc correctness

    • Fixed a typo in docs/develop.rst (dev dependencies0dev dependencies).

Example of the key navigation correction:

.. toctree::
   :caption: Contents
   :maxdepth: 1

   overview
   getting_started
   browser_control
   api
   develop
   changelog

Copilot AI linked an issue Jun 2, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix documentation links and update content Documentation link audit: fix dead/stale targets and remove duplicated README sections Jun 2, 2026
Copilot finished work on behalf of P4X-ng June 2, 2026 02:58
Copilot AI requested a review from P4X-ng June 2, 2026 02:58
@P4X-ng
Copy link
Copy Markdown
Contributor

P4X-ng commented Jun 2, 2026

/gemini review

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request cleans up the documentation by removing outdated sections, fixing a typo in docs/develop.rst, updating index references, and replacing old Chromium download links with a link to 'Chrome for Testing'. Feedback suggests adding a warning note about potential protocol mismatches, as 'Chrome for Testing' only offers modern builds (v113+) while this package targets an older Chrome DevTools Protocol version (r678025).

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/overview.rst
Comment on lines +33 to +35
**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/>`_.
Copy link
Copy Markdown

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation hygiene PR that fixes a broken Sphinx toctree reference, replaces dead Chromium snapshot URLs with the maintained Chrome for Testing page, removes duplicated tail content from the README, and corrects a typo in the develop guide.

Changes:

  • Replace non-existent connection toctree entry with browser_control in docs/index.rst and drop the trailing Hyperion Gray image block.
  • Swap obsolete per-platform Chromium snapshot zip links in docs/overview.rst for the Chrome for Testing landing page.
  • Trim duplicated API/Contributing/License sections from README.md and fix the dev dependencies0 typo in docs/develop.rst.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
docs/index.rst Fixes broken toctree target (connectionbrowser_control) and removes trailing branding image.
docs/overview.rst Replaces dead snapshot ZIP links with Chrome for Testing landing page.
README.md Removes duplicated tail sections, keeps concise type-system blurb.
docs/develop.rst Fixes typo dev dependencies0dev dependencies.

Copy link
Copy Markdown

@gcassist gcassist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request cleans up and updates the documentation, including fixing a typo in docs/develop.rst, updating the index to point to browser_control instead of connection, replacing outdated Chromium download links with a link to "Chrome for Testing" in docs/overview.rst, and condensing the type system description in README.md. The feedback recommends retaining the Hyperion Gray branding logos and links that were removed from both README.md and docs/index.rst.

Comment thread README.md
Comment on lines +135 to +136
All CDP types, commands, and events are fully typed with Python type hints for
IDE autocomplete, static type checking, and clear API contracts.
Copy link
Copy Markdown

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>

Comment thread docs/index.rst
Comment on lines 23 to 24
* :ref:`genindex`
* :ref:`modindex`
Copy link
Copy Markdown

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation

3 participants