Skip to content

Convert Lightning README to markdown #1142

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.

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

Merged
merged 32 commits into from
Jun 10, 2025
Merged

Convert Lightning README to markdown #1142

merged 32 commits into from
Jun 10, 2025

Conversation

AntonNI8
Copy link
Contributor

@AntonNI8 AntonNI8 commented Apr 28, 2025

Context:
Converting the Lightning README to a markdown file (README.md) instead of RST.
Includes adding a new logo+title banner image that will be shown on PyPI.

  • Add status imgs w/ hyperlinks
  • Add logo+title banner img
  • Convert remaining contents (ie. text, tables)
  • Handle existing .. include references to README from RST files in the codebase.
  • Remove deprecated README.rst

@AntonNI8 AntonNI8 added the documentation Improvements or additions to documentation label Apr 28, 2025
Copy link

codecov bot commented Apr 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.71%. Comparing base (eaf73ca) to head (9138037).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1142      +/-   ##
==========================================
- Coverage   96.51%   95.71%   -0.81%     
==========================================
  Files         246      183      -63     
  Lines       43130    29374   -13756     
==========================================
- Hits        41629    28114   -13515     
+ Misses       1501     1260     -241     
Flag Coverage Δ
unit_tests 95.71% <100.00%> (-0.81%) ⬇️

☔ 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.

@AntonNI8 AntonNI8 marked this pull request as ready for review May 8, 2025 20:44
@AntonNI8 AntonNI8 requested a review from maliasadi June 6, 2025 16:04
Copy link
Contributor

@LuisAlfredoNu LuisAlfredoNu left a comment

Choose a reason for hiding this comment

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

Thank you @AntonNI8
It is nice to see the new banner for Lightning ⚡
🥳

Copy link
Contributor

@mvandelle mvandelle left a comment

Choose a reason for hiding this comment

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

Thanks @AntonNI8, the new banner look nice ! 😎

@AntonNI8 AntonNI8 merged commit b062f55 into master Jun 10, 2025
94 checks passed
@AntonNI8 AntonNI8 deleted the readme_rst2md branch June 10, 2025 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants