Skip to content

fix (docs/user_guide.md): dropdowns, title, intro text - #1309

Merged
ajkswamy merged 11 commits into
mainfrom
fix/user_guide
Nov 11, 2026
Merged

ajkswamy merged 11 commits into
mainfrom
fix/user_guide

Conversation

@ajkswamy

Copy link
Copy Markdown
Collaborator

dropdowns animation fixed
FAQ reorganized into sections
title more aligned with scverse TOC agreement
more informative intro text

dropdowns animation fixed
FAQ reorganized into sections
title more aligned with scverse TOC agreement
more informative intro text
@ajkswamy
ajkswamy requested a review from jan-glx November 10, 2026 17:22
@ajkswamy ajkswamy self-assigned this Nov 10, 2026
@codecov

codecov Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.43%. Comparing base (bf43e7c) to head (afa2081).
⚠️ Report is 1 commits behind head on main.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jan-glx jan-glx left a comment •

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.

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

  1. d62325f typos/grammar (Checkout → Check out, infrastucture, a broken parenthesis, …)
  2. 8929c23 section 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")
  3. 0409617 descriptive link labels instead of "here" / "this tutorial"
  4. db3cb78 re-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

  1. fda492b start all questions folded. With some open and some closed, it's hard to see at a glance what's there
  2. 210420e "analyze a spatial subset" → "select a spatial subset", so it doesn't sound like it belongs under "Visualization and Analysis"
  3. e0106ef title: I'd lean towards keeping "User Guide", since index.md (the card) and quickstart.md ("The {doc}user_guide points 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.

@jan-glx
jan-glx self-requested a review November 10, 2026 21:57

@jan-glx jan-glx left a comment

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.

please add at least db3cb78

jan-glx and others added 7 commits November 11, 2026 11:13
…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
@ajkswamy

Copy link
Copy Markdown
Collaborator Author

Thanks @jan-glx for spotting those remaining issues. I have added all your fixes and suggestion with minor further improvements

@ajkswamy
ajkswamy merged commit d4427cf into main Nov 11, 2026
21 checks passed
@ajkswamy
ajkswamy deleted the fix/user_guide branch November 11, 2026 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants