Conversation
Expanded the README with clearer positioning, detailed method tables, diagnostics, consulting, and citation instructions. Updated docs index to include badges, improved quickstart, and synchronized feature/method descriptions with the README for consistency and easier onboarding.
drbenvincent
requested review from
NathanielF,
OriolAbril,
juanitorduz,
jwilkinson88 and
nialloulton
drbenvincent
changed the title
README.md and docs homepage
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #648 +/- ##
=======================================
Coverage 94.35% 94.35%
=======================================
Files 44 44
Lines 7517 7517
Branches 456 456
=======================================
Hits 7093 7093
Misses 262 262
Partials 162 162 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Added new badges for PyPI, conda-forge, license, pre-commit, and downloads. Improved badge organization and updated styles for better visibility in both README.md and docs/source/index.md.
Changed the conda-forge badge in README.md and docs index to use a green color for improved visibility and consistency.
Changed the Interrogate badge in README.md to use a raw GitHub URL and added conda installation instructions. Simplified docs/source/index.md by removing duplicate badges, installation, and support sections, relying more on README.md content.
Revised the descriptions of decision contexts in the README for improved clarity and specificity regarding causal inference methods.
| @@ -4,26 +4,47 @@ | |||
|
|
|||
| ---- | |||
There was a problem hiding this comment.
I might move this after the badges or use a commented out indicator to signal the start of what gets added to the website homepage. Another option could be to make the logo smaller.
My main concern is that I think the first thing that gets the visitor attention on the website homepage should be the "tagline" for the project. In the current homepage (which by itself is far from ideal but a slightly different topic) I think this kind of happens already
in 1 second you get the "causal inference for quasi-experiments" take away. With the badges I am not sure what 1 second take away a visitor would get:
Disclaimer, as a general rule, I do like markdown badges but I think they are something that should be limited to the github readme. I don't think the more general public who will get to the website gets much useful information from them. Therefore my suggestion is to remove them from the homepage, which I think is simpler implementation wise too, but relocating them to allow for the tagline to be a 1 second take away would also be perfectly fine.
Badges are now excluded from the docs homepage by using a <!-- docs-start --> comment marker in README.md. The website include skips past the badges so the first thing visitors see is the project tagline. Also reduced logo width to 40%. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Addressed the badge/tagline feedback:
The single-source-of-truth approach is preserved — the website still pulls its content from |
2 participants
Summary
This PR updates the README and documentation homepage to better communicate CausalPy's value proposition as a research-grade causal inference library for quasi-experimental designs.
#637 will be tackled separately
Changes
README.md
result.plot()andresult.summary()showdocs/source/index.md
{include}directive to avoid redundancy and drift.ioand.com)Badge improvements (both files)
New badges added:
Badge organization:
Badges are now grouped into three logical rows for visual clarity:
Style consistency:
socialtoflatstyle to match other badgesMotivation
Per the positioning spec, this update aims to:
Testing
make html)