Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(training): Docathon #201

Merged
merged 101 commits into from
Mar 27, 2025
Merged

docs(training): Docathon #201

merged 101 commits into from
Mar 27, 2025

Conversation

JPXKQX
Copy link
Member

@JPXKQX JPXKQX commented Mar 18, 2025

Description

  • move general contributing guidelines to main anemoi docs and link here
  • restructure user guides, e.g. for building training configs
  • closes Dead link in user guide #166

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

📚 Documentation preview 📚: https://anemoi-training--201.org.readthedocs.build/en/201/


📚 Documentation preview 📚: https://anemoi-graphs--201.org.readthedocs.build/en/201/


📚 Documentation preview 📚: https://anemoi-models--201.org.readthedocs.build/en/201/

@FussyDuck
Copy link

FussyDuck commented Mar 18, 2025

CLA assistant check
All committers have signed the CLA.

@HCookie HCookie changed the title WIP: contributing guidelines docs: Docathon Mar 18, 2025
@mchantry mchantry changed the title docs: Docathon docs(training): Docathon Mar 18, 2025
@VeraChristina
Copy link
Collaborator

VeraChristina commented Mar 26, 2025

There are broken links and a few unclear references in the user guide (e.g. a reference to "Getting started" but no "getting started" section) -- planning to fix these later today, before merging. cc @HCookie


I fixed all internal links I could find, and got rid off sentences that referred/linked into nowhere (when I couldn't find where they were supposed to link to).

The user guide could use some more restructuring but I think this is out of scope for this PR. I think we can merge (so that we don't block other PRs that want to add documentation) and do other changes later

@VeraChristina VeraChristina marked this pull request as ready for review March 26, 2025 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Dead link in user guide
9 participants