Skip to content

Huge docs refactor for clarity#116

Merged
JoelLucaAdams merged 9 commits intomainfrom
refactor-docs-for-clarity
Apr 8, 2026
Merged

Huge docs refactor for clarity#116
JoelLucaAdams merged 9 commits intomainfrom
refactor-docs-for-clarity

Conversation

@JoelLucaAdams
Copy link
Copy Markdown
Collaborator

Complete refactor of several of the doc pages in order to improve clarity and readability. Honestly a bit of a mess to read the changelog but just view the docs online and see what you think.

I've given up on keeping the markdown files to no longer than 80 characters long... Feel that it actually disrupts the flow of writing it

Copy link
Copy Markdown
Collaborator

@LiamPattinson LiamPattinson left a comment

Choose a reason for hiding this comment

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

Generally all good, just a few stylistic/grammar changes I'd recommend.

JoelLucaAdams and others added 5 commits April 8, 2026 17:01
Co-authored-by: Liam Pattinson <LiamPattinson@users.noreply.github.com>
Co-authored-by: Liam Pattinson <LiamPattinson@users.noreply.github.com>
Co-authored-by: Liam Pattinson <LiamPattinson@users.noreply.github.com>
Co-authored-by: Liam Pattinson <LiamPattinson@users.noreply.github.com>
Co-authored-by: Liam Pattinson <LiamPattinson@users.noreply.github.com>
@JoelLucaAdams
Copy link
Copy Markdown
Collaborator Author

This does actually pass the docs build https://app.readthedocs.org/projects/sdf-xarray/builds/32171291/

@JoelLucaAdams JoelLucaAdams merged commit f024bde into main Apr 8, 2026
14 of 15 checks passed
@JoelLucaAdams JoelLucaAdams deleted the refactor-docs-for-clarity branch April 8, 2026 16:29
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