Repository navigation
Trimming README and docs landing page - #778
maximelucas wants to merge 15 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #778 +/- ##
==========================================
+ Coverage 94.87% 94.92% +0.04%
==========================================
Files 65 66 +1
Lines 5382 5473 +91
==========================================
+ Hits 5106 5195 +89
- Misses 276 278 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
@maximelucas let me know when this is ready to review or if you need help! |
leotrs
left a comment
leotrs
left a comment
There was a problem hiding this comment.
Overall this is a big improvement. The nav pill, the Quickstart with inline comments, and BibTeX wrapped in <details> are all good moves.
Two substantive things worth thinking about before taking out of draft:
-
Feature breadth. The old bullet list ("XGI can create / read / represent / analyze / manipulate / draw") did more work than it looks: a visitor scrolling fast walked away knowing the library covers all five areas. The new one-paragraph intro is terser but harder to scan at a glance. Worth keeping some condensed version, maybe as a short list right under the Quickstart or as the first line of the intro.
-
Intentional drops to confirm. Mailing list, Mastodon handle, and the
OTHER_RESOURCES.mdpointer are all gone. If they're dead or deprecated, fine. IfOTHER_RESOURCES.mdis still a live file in the repo, a one-line footer link would keep it discoverable.
Timing-wise, this lands well with the v1.0 story.
|
Thanks guys. It can be ready very quickly but can you have a look at #779 which is kinda blocking? The online doc preview doesn't seem to work anymore. |
Documentation build overview
144 files changed ·
|
|
Hey @leotrs @maximelucas --- I fixed #779. I agree with Leo that the issues he pointed out should be addressed. |
leotrs
left a comment
leotrs
left a comment
There was a problem hiding this comment.
Updates look good. My two earlier concerns are addressed:
- Feature breadth: the new intro ("data structures, generative models, measures, datasets, and drawing tools") covers scope in a scannable sentence. Good.
- Mailing list / Mastodon drops: confirmed intentional, keeping the trim.
One remaining decision and one small flag:
OTHER_RESOURCES.mdis still a live file (listing other higher-order network packages across Julia / Python / R) but nothing in the README points to it anymore, so it's effectively orphaned. Pick one: delete the file, or add a one-line footer link under Contribute (something like "See also other higher-order network software"). Fine either way, just needs a call.- The PR title mentions "docs landing page" but the diff only touches
README.mdand.readthedocs.yaml. Was thedocs/source/index.rsttrim intentionally deferred, or did it get dropped from scope?
Nothing blocking. Happy to approve once the OTHER_RESOURCES.md call is made.
- Keep the feature list (data structures, generative models, measures, datasets, drawing tools) in the intro, framed as covering the whole workflow - Link OTHER_RESOURCES.md from the end of the README so it is no longer orphaned - Split License and Support into separate sections
Shorter intro, feature cards, and a getting-started section with the same quickstart example as the README.
Use the README's first two sentences, replace the General purpose card (now covered by the intro) with Easy to use, and add Built by researchers and Open source and community-driven cards.
|
Thanks guys.
In docs landing page:
|
No description provided.