Generally describe GeoIPS and its different components. Provide enough information so that if someone is looking for something, they can find it here and navigate to individual sections.
Files to be edited
docs/source/new-docs/concepts/index.rst
Resources to be created
No resources need to be created unless icons are added to the document.
Related Documentation
Functionality from the CLI
Interfaces
Module base
YAML base
Architecture
Overview
History of GeoIPS
Scope of Documentation
Does NOT include
Detailed information about any concepts in GeoIPS
Does include
Sparse, high-level summary information
Links to other sections
Checklist for Completion
[ ] Work done on a feature branch, eg. documentation-adding-functionality
[ ] Write the required documentation in RST.
[ ] Add any required resource files to a sub-folder
[ ] Run ./docs/build_docs.sh html_only to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.
[ ] Update the relevant release notes.
[ ] Readable and followable writing, please use a grammar checker + spell checker
[ ] Passes doc8 checks, see the sphinx RST Primer and checkout this black-like tool @biosafetylvl5 wrote for auto-formatting RST files: pink
[ ] A PR from your feature branch to main 😊 with @biosafetylvl5 as a reviewer
Due on for review on: July 15, 2024
Documentation Task
Files to be edited
docs/source/new-docs/concepts/index.rst
Resources to be created
Related Documentation
Scope of Documentation
Checklist for Completion
./docs/build_docs.sh html_only
to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.main
😊 with @biosafetylvl5 as a reviewer