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 AGATE documentation #237

Open
WilliGautier opened this issue Feb 24, 2025 · 0 comments
Open

Create AGATE documentation #237

WilliGautier opened this issue Feb 24, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@WilliGautier
Copy link
Contributor

In docs/docs folder, create a agate folder containing:

  • agate_api.md (Single line file containing: <redoc src="./openapi.json"/>)
  • agate_doc.md (md documentation of the AGATE service)
  • openapi.json (the openapi file that will be used with redoc mkdocs plugin to generate api documentation)

The generation of the openapi.json file has to be added to mkDocs.sh following the example of AIRS/FAM/APROC

The new agate documentation needs to be added to the ARLAS Documentation Table of Content

@WilliGautier WilliGautier added the documentation Improvements or additions to documentation label Feb 24, 2025
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
None yet
Development

No branches or pull requests

2 participants