Skip to content

Conversation

@VeckoTheGecko
Copy link
Collaborator

This PR proposes a restructure to the documentation at the top level

Previous:

Home
quickstart
tutorials
contributing
OceanParcels <https://oceanparcels.org>

Now:

Home
user-guide
api
contributing
OceanParcels <https://oceanparcels.org>

This new top-level structure creates a User Guide section where the Quickstart and Tutorial pages live. With the old structure, it wasn't clear where user content would go that isn't quickstart or tutorials (e.g., info on how 'fetch' works).

This is also useful for #105 where these top level items occupy the navbar, hence we can't have too many.

I think this restructure is best to do now rather than later (as this would break documentation links that have been shared before).

@erikvansebille
Copy link
Member

I'd like to see the new page after #105 is merged in, but for now I also think there could be a bit more/thorough introduction text at the top of the landing page. @ammedd, could you write a paragraph that better fleshes out what the project/tool is about? Perhaps also highlighting the difference between the VirtualShipParcels tool and the Virtual Ship Classroom material?

@VeckoTheGecko
Copy link
Collaborator Author

I also think there could be a bit more/thorough introduction text at the top of the landing page ... write a paragraph that better fleshes out what the project/tool is about?

This can be done by modifying the README, as the landing page is just a copy of the readme (trimming off some of the top). Anything after <!-- SPHINX-START --> will be included on the landing page.

@VeckoTheGecko
Copy link
Collaborator Author

I'd like to see the new page after #105 is merged in

Done @erikvansebille See docs

@VeckoTheGecko VeckoTheGecko merged commit 1466d24 into main Jan 23, 2025
10 checks passed
@VeckoTheGecko VeckoTheGecko deleted the v/doc-restructure branch January 23, 2025 14:06
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.

3 participants