Repository navigation
fix (docs/user_guide.md): dropdowns, title, intro text - #1309
Conversation
dropdowns animation fixed FAQ reorganized into sections title more aligned with scverse TOC agreement more informative intro text
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1309 +/- ##
=======================================
Coverage 91.43% 91.43%
=======================================
Files 53 53
Lines 8395 8395
=======================================
Hits 7676 7676
Misses 719 719 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Nice! Your grouping and the fix of the folding make the page readable again, and even nice to look at.
Some of the nesting got lost in the restructuring, so I opened a small PR on top of your branch: #1310. While at it, I also fixed some pre-existing issues and added a few suggestions. The commits are ordered from "pretty sure" to "matter of taste", so feel free to take just the first few, or cherry-pick:
Fixes
d62325ftypos/grammar (Checkout → Check out, infrastucture, a broken parenthesis, …)8929c23section headings as##, so the page has a single H1 (the sections now show up at the same level as the page title in "On this page")0409617descriptive link labels instead of "here" / "this tutorial"db3cb78re-nest the sub-questions that got separated from their parent questions: "If you want to play around with existing data." is a stray dropdown now, "How do I annotate my data?" and "How do I analyze a spatial subset…?" only show their intro text, and their answers float around as unrelated dropdowns. I nested them back as dropdowns inside their question (also under "create", instead of tabs, so all sub-cases work the same way), and replaced "see the previous section … below" with a real link.
Suggestions, take or leave
fda492bstart all questions folded. With some open and some closed, it's hard to see at a glance what's there210420e"analyze a spatial subset" → "select a spatial subset", so it doesn't sound like it belongs under "Visualization and Analysis"e0106eftitle: I'd lean towards keeping "User Guide", since index.md (the card) and quickstart.md ("The {doc}user_guidepoints you…" now renders as "The How-to guides points you…") still use the old name. But if "How-to guides" is what the scverse TOC agreement says, I'm happy to drop that commit and update the card + quickstart sentence instead. Or would "FAQ" fit even better? The intro already calls them FAQs.
Number 4 would be essential, I think.
…stion
- 'play around with existing data' is again an option of 'How do I create a SpatialData object?'
- the annotate and spatial-subset sub-questions are nested in their parent dropdowns again
- use nested dropdowns for all sub-cases (also replaces the tabs under 'create')
- replace the stale 'see the previous section ... below' with a {ref} link
both improved to be consistent and coherent with changes to user_guide
|
Thanks @jan-glx for spotting those remaining issues. I have added all your fixes and suggestion with minor further improvements |
dropdowns animation fixed
FAQ reorganized into sections
title more aligned with scverse TOC agreement
more informative intro text