first draft of docs

[mc4117]

Need for Documentation

Replace #20

Description:

We currently lack sufficient documentation for our project. This makes it difficult for new contributors to get started and for users to understand how to use our software effectively.

Why this is important:

1. Onboarding New Contributors: Clear documentation will help new contributors understand the project structure, coding standards, and how to set up their development environment.
2. User Support: Comprehensive user guides and FAQs can reduce the number of user queries and support requests.
3. Consistency: Documented processes ensure consistency in development and deployment.

Proposed Solution:

1. Developer Guide:

   • Project structure overview
   • Coding standards and best practices
   • Setup and installation instructions
   • Contribution guidelines

2. User Guide:

   • How to install and configure the software
   • Basic usage instructions
   • Common troubleshooting steps

3. API Documentation:

   • Detailed descriptions of API endpoints
   • Example requests and responses
   • Authentication and authorization procedures

Tasks:

• Outline the structure for the Developer Guide.
• Draft the User Guide.
• Generate and organize API documentation.
• Review and edit all documentation for clarity and completeness.
• Publish documentation on the project's GitHub Wiki or website.

Additional Notes:

Any contributions towards this documentation effort are welcome. If you have experience with writing technical documentation or have suggestions, please comment below or create a pull request.

---

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

[FussyDuck]

All committers have signed the CLA.

[gmertes]

Can we rename the png folder to something generic like images ?

[gmertes]

Seems like @gareth-j contribution got lost somewhere.

When we squash merge this one, don't forget to add to the description:

Co-authored-by: Gareth Jones <[email protected]>