Populate the Table of Contents (TOC) so it links to all the important documents and write a general summary of the overall structure of the docs. This includes explaining where people can find things and providing top-level information about GeoIPS with extensive linking to important content.
Files to be edited
docs/source/new-docs/homepage.rst
docs/source/new-docs/index.rst
Resources to be created
N/A
Related Documentation
Homepage
Scope of Documentation
Does NOT include
In-depth description of the functionality
Architecture details
Direct links to tutorials or any content that might change
Does include
Good top-level descriptions of the documentation content
Where to find more information
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: June 3rd
Documentation Task
Files to be edited
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