Skip to content

Fix docs#455

Merged
ppinchuk merged 25 commits into
mainfrom
pp/fix_docs
May 29, 2026
Merged

Fix docs#455
ppinchuk merged 25 commits into
mainfrom
pp/fix_docs

Conversation

@ppinchuk
Copy link
Copy Markdown
Collaborator

Fix README and touch up docs. Should be able to publish again

@ppinchuk ppinchuk self-assigned this May 29, 2026
Copilot AI review requested due to automatic review settings May 29, 2026 22:55
@ppinchuk ppinchuk requested a review from castelao as a code owner May 29, 2026 22:55
@ppinchuk ppinchuk added the documentation Improvements or additions to documentation label May 29, 2026
@ppinchuk ppinchuk added bugfix Fixed a known bug p-high Priority: high labels May 29, 2026
@ppinchuk ppinchuk merged commit 2520ec5 into main May 29, 2026
7 of 8 checks passed
@ppinchuk ppinchuk deleted the pp/fix_docs branch May 29, 2026 22:58
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

This PR updates the project’s documentation/README to improve published docs output (and enable publishing again), including restructuring content across the README and Sphinx pages and refreshing the CLI docs rendering.

Changes:

  • Reworked README.rst formatting (logo, updated intro, trimmed sections, updated links).
  • Added an “About” docs page sourced from the README intro plus additional content, and updated the docs index/toctree structure.
  • Updated Sphinx HTML theme options and switched the CLI docs page to render directly from the Click entrypoint.

Reviewed changes

Copilot reviewed 6 out of 11 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
README.rst Adds logo/header formatting and updates/condenses the README content and links.
docs/source/misc/about.rst New “About” page that includes the README intro and restores detailed background sections.
docs/source/index.rst Updates the docs navigation and changes what portion of the README is included on the landing page.
docs/source/conf.py Adjusts theme options/title and sets a logo for HTML output.
docs/source/cli.rst Renders CLI docs directly via sphinx-click from the Click main entrypoint.
docs/source/_cli/compass.rst Removes the old CLI page stub (superseded by docs/source/cli.rst).

Comment thread README.rst
Comment thread README.rst
Comment thread README.rst
Comment thread docs/source/conf.py
Comment thread docs/source/index.rst
Comment thread docs/source/misc/about.rst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix Fixed a known bug documentation Improvements or additions to documentation p-high Priority: high

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants