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

Create a general template for the packages #20

Open
gareth-j opened this issue Mar 18, 2025 · 2 comments
Open

Create a general template for the packages #20

gareth-j opened this issue Mar 18, 2025 · 2 comments
Labels

Comments

@gareth-j
Copy link
Member

gareth-j commented Mar 18, 2025

We need a general template fo the packages. We should have

For each of the packages

  • Introduction
  • User Guide
  • Command Line Interface
  • API Reference
  • Contributions
  • FAQ

In the higher level documentation:

  • Overview
  • User Guide
  • Installing
  • Contributing
@corentincarton
Copy link
Contributor

corentincarton commented Mar 19, 2025

After the docathon, we still need to do the following:

  • Enforce the structure above in all the packages
  • Review the entire "Contributing" section
  • Review the landing page of the main documentation and reorganise sections
  • Reference the "Contributing" section from the main anemoi documentation in the anemoi packages, see anemoi-core/training as an example.
  • Add a code of conduct, we can simply link to https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct
  • Review/update/add all the links

@VeraChristina to lead this task, tagging @aaron-hopkinson to lead the user guide on the main documentation.

@anaprietonem
Copy link

About the 'Enforce the structure above in all the packages', if we could have a cookiecutter template repo that people could pull from when doing new docs. It doesn't address the aspect about enforcing it on current packages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants