Skip to content

Conversation

@codingjoe
Copy link
Owner

No description provided.

Copilot AI review requested due to automatic review settings December 18, 2025 12:56
@codingjoe codingjoe self-assigned this Dec 18, 2025
Copy link

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 modernizes the project's documentation infrastructure by migrating from reStructuredText (RST) to Markdown format for the README, adding custom light/dark theme logos, and consolidating build configurations.

  • Migrated README from RST to Markdown format with improved formatting and GitHub-native features
  • Added SVG logos with light and dark theme variants
  • Removed obsolete configuration files (setup.cfg, linter-requirements.txt, MANIFEST.in, SECURITY.md)

Reviewed changes

Copilot reviewed 9 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
setup.cfg Removed flake8 configuration (likely moved to pyproject.toml or no longer needed)
pyproject.toml Updated readme reference from RST to MD format; added furo Sphinx theme dependency
linter-requirements.txt Removed separate linter dependencies file (consolidated elsewhere)
images/logo-light.svg Added new light theme logo for the project
images/logo-dark.svg Added new dark theme logo for the project
docs/index.rst Updated to display theme-appropriate logos instead of including README
docs/conf.py Added furo as the HTML theme for Sphinx documentation
SECURITY.md Removed Tidelift security contact information
README.rst Removed old reStructuredText README file
README.md Added new Markdown README with badges, logos, and improved formatting
MANIFEST.in Removed manifest file (likely no longer needed with modern build tools)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codingjoe codingjoe merged commit cc952e1 into main Dec 18, 2025
12 of 13 checks passed
@codingjoe codingjoe deleted the readme branch December 18, 2025 13:15
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.

2 participants