Skip to content

docs: align docs with template #195

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

Merged
merged 6 commits into from
Mar 27, 2025
Merged

Conversation

VeraChristina
Copy link
Collaborator

@VeraChristina VeraChristina commented Mar 26, 2025

Description

  • Add reference to main anemoi contributing guidelines
  • remove empty sections from docs
  • Align section titles with template

📚 Documentation preview 📚: https://anemoi-inference--195.org.readthedocs.build/en/195/

@github-project-automation github-project-automation bot moved this to Now In Progress in Anemoi-dev Mar 26, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 26, 2025
@VeraChristina VeraChristina marked this pull request as ready for review March 26, 2025 16:34
Copy link
Contributor

@aaron-hopkinson aaron-hopkinson left a comment

Choose a reason for hiding this comment

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

Again, looks good - thank you.

As with the graphs/datasets PRs there's the potential for some inconsistency Re: command line tool/usage (see ecmwf/anemoi-core#219).

I also noticed a few small issues on the index page, e.g.

  • The "About Anemoi" text is included twice.
  • The quick overview has a link which isn't rendering properly ("generating your first forecast")
  • The link to the main docs index page is also broken (as with datasets/graphs PRs).

Not sure if you want to tackle those in this PR, or we can do this in a follow-on.

@VeraChristina
Copy link
Collaborator Author

As with the graphs/datasets PRs there's the potential for some inconsistency Re: command line tool/usage (see ecmwf/anemoi-core#219).

I have reverted the corresponding change in graphs for consistency.

I also noticed a few small issues on the index page, e.g.

* The "About Anemoi" text is included twice.

Removed and changed the layout to match that of graphs. Also removed the sentence that seems to have been copied from anemoi-utils.

* The quick overview has a link which isn't rendering properly ("generating your first forecast")

* The link to the main docs index page is also broken (as with datasets/graphs PRs).

Both fixed

Copy link
Contributor

@aaron-hopkinson aaron-hopkinson left a comment

Choose a reason for hiding this comment

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

Thank you 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants