Skip to content

Conversation

chrisb13
Copy link

First attempt at wombat docs

Copy link

github-actions bot commented Aug 22, 2025

PR Preview
🚀 Preview of PR head d3f509c deployed to https://access-nri.github.io/GFDL-generic-tracers/pr-preview-57
2025-08-25 12:42 AEST
Preview generated through the Deploy to GitHub Pages workflow run 17197619279.

@chrisb13 chrisb13 changed the title first go at wombat docs! Adding wombat docs! Aug 22, 2025
@pearseb
Copy link
Collaborator

pearseb commented Aug 22, 2025

Which files do I edit to add the documentation? And thanks Chris for pushing this forward.

@chrisb13
Copy link
Author

chrisb13 commented Aug 22, 2025

Hi @pearseb, sorry this has taken forever!

So there's (at most) two steps to adding content. If you just want to edit the landing page, then you can write markdown stuff here. (This is the one step option.)

If you want add a new page (two step option), then you want to add another markdown file in that folder:
https://github.com/ACCESS-NRI/GFDL-generic-tracers/blob/cbull/mkdoc_wombat/documentation/docs/pages/

And then also tell the doc system that it needs to include it by adding a line here:

nav:
- Home: index.md

Note that for things that arn't the landing page you'll need to add a pages to the path, you can see examples here.

If you push changes to this branch, then it should update the preview of the docs here.

Do reach out if anything is unclear. Looking forward to getting some content :)

@chrisb13 chrisb13 marked this pull request as ready for review August 22, 2025 08:02
@chrisb13 chrisb13 requested a review from dougiesquire August 22, 2025 08:02
clean up of files

further clean up of files
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