Skip to content

README cleanup - #806

Merged
milton-minervino merged 2 commits into
developfrom
feature/update-readme
Oct 21, 2026
Merged

milton-minervino merged 2 commits into
developfrom
feature/update-readme

Conversation

@milton-minervino

Copy link
Copy Markdown
Collaborator

Summary

README cleanup: fix rendering glitches and broken links, bring "What's new" up to date, and list all current tutorials.

Closes #730

Badges

  • Removed the stray dashes between badges. The whitespace inside each <a> was rendered as underlined link text, the same issue Add P16 and INRIA logo #797 fixed for the contributor logos.
  • Badges now link to real pages: PyPI (version, Python versions), pepy.tech (downloads), LICENSE (license). Before, they linked to their own badge images.
  • The docs badge and all Read the Docs links point to stable instead of latest, which is hidden on RTD.

What's new

  • One row per minor release, limited to the most notable features. Releases that only changed compatibility or did small improvements (2.5, 2.6, 2.9) are left out.
  • New rows: 2.10 (Smart Report redesign, waterfall local_plot), 2.8 (Global–Local importance and clusters in the webapp), 2.7 (feature importance by subpopulation), 2.4 (any SHAP-supported model), 2.1 (correlation matrix clustering).
  • Demo and article links kept on every row, and added where they were missing (1.3 and 1.4 articles).
  • Short intro sentence, plus a link to GitHub Releases for full details.
  • The NLP preview row now links to develop.

Broken links and content fixes

  • Removed links to the FastTreeSHAP tutorial, which was deleted in Fix notebook tutorials #781. "How Shapash works" now points to the custom backend tutorial.
  • NLP section links moved from feature/nlp-refacto to develop.
  • Quickstart: "4 steps" changed to "5 steps", and the step 1 and 2 wording fixed.
  • Install commands quoted (pip install "shapash[report]") so they also work in zsh.

Tutorials

  • Every notebook in tutorial/ is now listed. Added: plot07, ShapIQ, debugging and what-if (3), production (FastAPI, batch scoring), domain examples (6), NLP (2).
  • Links are now absolute GitHub URLs, so they also work on the PyPI project page, which renders this README.

Polish

  • Removed the duplicated "supported models" paragraph and the duplicated demo link in the Quickstart.
  • "Medium:" renamed to "Articles:" (the list also includes KDnuggets and Towards DS).
  • Rewrote a garbled sentence in Features.
  • Image URLs all use raw.githubusercontent.com.

@milton-minervino milton-minervino added the documentation Improvements or additions to documentation label Oct 20, 2026
@milton-minervino milton-minervino linked an issue Oct 20, 2026 that may be closed by this pull request
@codecov

codecov Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.08%. Comparing base (938be9e) to head (399ffd0).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #806   +/-   ##
========================================
  Coverage    86.08%   86.08%           
========================================
  Files          115      115           
  Lines        11825    11825           
  Branches      2158     2158           
========================================
  Hits         10180    10180           
  Misses        1009     1009           
  Partials       636      636           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread README.md
<a href="https://shapash.readthedocs.io/en/latest/">
<img src="https://readthedocs.org/projects/shapash/badge/?version=latest" alt="doc">
</a>
<a href="https://shapash.readthedocs.io/en/stable/"><img src="https://readthedocs.org/projects/shapash/badge/?version=stable" alt="doc"></a>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Not sure why but this badge does not render well on your branch:
https://github.com/MAIF/shapash/tree/feature/update-readme
Can you try to use the target link: https://app.readthedocs.org/projects/shapash/badge/?version=stable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Forget it, everything's fine.

@milton-minervino
milton-minervino merged commit de154dd into develop Oct 21, 2026
10 checks passed
@milton-minervino
milton-minervino deleted the feature/update-readme branch October 21, 2026 15:57
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.

Update Readme

2 participants