Skip to content

Conversation

@jaredmixpanel
Copy link
Contributor

Summary

  • Converted README.rst to README.md for better GitHub rendering and compatibility
  • Preserved all original content, links, and structure
  • Added proper markdown syntax highlighting for code blocks

Changes

  • Deleted README.rst
  • Created README.md with equivalent content
  • Updated badges to use markdown syntax
  • Converted code blocks to use markdown fenced code blocks with Python syntax highlighting
  • Converted reference-style links to inline markdown links
  • Added DeepWiki badge for additional documentation support

Test plan

  • Verify all links work correctly
  • Confirm badges display properly
  • Check code blocks render with syntax highlighting
  • Ensure all original content is preserved

- Convert README.rst to README.md for better GitHub rendering
- Maintain all original content and links
- Update code blocks to use markdown syntax with proper highlighting
- Convert badges to markdown format
- Add DeepWiki badge for additional documentation support
@jaredmixpanel jaredmixpanel merged commit f43ead4 into master Dec 9, 2025
10 checks passed
@jaredmixpanel jaredmixpanel deleted the convert-readme-to-markdown branch December 9, 2025 17:53
@codecov
Copy link

codecov bot commented Dec 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.28%. Comparing base (7d93632) to head (fb398ef).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #151   +/-   ##
=======================================
  Coverage   94.28%   94.28%           
=======================================
  Files           9        9           
  Lines        1557     1557           
  Branches      101      101           
=======================================
  Hits         1468     1468           
  Misses         54       54           
  Partials       35       35           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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