Skip to content

[DOCS] Cleaning up the User Guide#2737

Merged
erikvansebille merged 10 commits into
Parcels-code:mainfrom
erikvansebille:cleaningup-userguide
Jul 9, 2026
Merged

[DOCS] Cleaning up the User Guide#2737
erikvansebille merged 10 commits into
Parcels-code:mainfrom
erikvansebille:cleaningup-userguide

Conversation

@erikvansebille

@erikvansebille erikvansebille commented Jul 8, 2026

Copy link
Copy Markdown
Member

Description

This PR cleans up the user guide on the docs.parcels-code.org page. in particular, it moves the Getting Started section into the User Guide itself, so that everything is in one place. It also adds some clarifying wording, removes the (duplicate) installation-instructions on the v4 page and adds anchor links to the headings on the User Guide

Checklist

AI Disclosure

  • This PR contains AI-generated content.
    • I have tested any AI-generated content in my PR.
    • I take responsibility for any AI-generated content in my PR.
    • Describe how you used it (e.g., by pasting your prompt): Creating custom css for adding anchors to the headers that don't show up in the side-bar

@erikvansebille erikvansebille changed the title [DOCS[ Cleaning up the User Guide [DOCS] Cleaning up the User Guide Jul 8, 2026
Comment thread docs/_static/custom.css

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you elaborate on what this does? Which anchor tags were you having problems with? I think it would be better to work within the pydata-sphinx theme we're using rather than adding custom CSS (as its more difficult to maintain)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes, I added the custom CSS because I wanted both headers on the main page (that could be anchored so we could directly link to a section) as well as a table-of-content in the left side-bar. See screenshot
Screenshot 2026-07-09 at 12 43 03

Without this custom css, the headers would appear twice in the main body, see orange circles in the screenshot below
Screenshot 2026-07-09 at 12 52 36

I asked an LLM how to do this and after a lot of back-and-forth this was the solution it came up with. If you have a better idea, then I'd be curious to hear!

This comment was marked as off-topic.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I misunderstood your original message here. I don't know if there's a way to do this without custom css

I'll leave it up to you, but just wanted to flag dabbling in custom css does add an additional maintenance burden

@VeckoTheGecko VeckoTheGecko left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changes look good. Just a question about the custom css

@erikvansebille erikvansebille merged commit a6bb153 into Parcels-code:main Jul 9, 2026
17 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in Parcels development Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants