Create a comprehensive "Getting Started" page that serves as a central hub for new users to understand the initial steps needed to use GeoIPS, including system requirements, installation steps, best practices, and links to developers.
Files to be edited
docs/source/new-docs/getting-started/index.rst (you will need to create it)
Resources to be created
Top-level narrative description for the "Getting Started" page.
Links to system requirements, installation guide, best practices, and developers' resources.
Related Documentation
Tutorials Section: Provides detailed tutorials on how to use various features of GeoIPS.
Includes step-by-step guides.
Example code and use cases.
Conceptual Section: Explains the underlying concepts and architecture of GeoIPS.
Detailed explanations of core concepts.
Diagrams and flowcharts illustrating the system architecture.
Contributing Section: Information on how to contribute to the GeoIPS project.
Guidelines for contributing code.
Standards for documentation contributions.
Best practices for submitting pull requests.
System Requirements: Detailed hardware and software requirements for running GeoIPS.
Installing: Step-by-step installation guide for setting up GeoIPS.
Best Practices: Recommended best practices for using GeoIPS effectively, including tips for both research and operational use.
Scope of Documentation
Does NOT include
Detailed descriptions of how to install GeoIPS.
Detailed system requirements.
Detailed best practices.
Description of what GeoIPS is.
Description of the tutorials, beyond linking out.
Conceptual explanation of how GeoIPS works.
Does include
Top-level narrative description and direction for new users.
Links to the system requirements.
Links to the installation guide.
Links to best practices.
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