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

Feature/jk/docs #2356

Merged
merged 9 commits into from
Sep 21, 2023
Merged

Feature/jk/docs #2356

merged 9 commits into from
Sep 21, 2023

Conversation

JulesKouatchou
Copy link
Contributor

Description

Created a new docs directory that has the following subdirectories:

  • tutorial: what used to be a top directory (with the same content)
  • user_guide: a new directory that will serve as MAPL User's Guide.

Related Issue

Motivation and Context

The changes are meant to create an area where all the documentation will be located.
Note that it does not include the documentation generated by FORD.

How Has This Been Tested?

No test was needed here. The changes produce 0 diff.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Trivial change (affects only documentation or cleanup)

Checklist:

  • I have tested this change with a run of GEOSgcm (if non-trivial)
  • I have added one of the required labels (0 diff, 0 diff trivial, 0 diff structural, non 0-diff)
  • I have updated the CHANGELOG.md accordingly following the style of Keep a Changelog

@JulesKouatchou JulesKouatchou requested review from a team as code owners September 18, 2023 18:11
@mathomp4 mathomp4 changed the base branch from main to develop September 18, 2023 18:37
@mathomp4
Copy link
Member

I moved the base of this to develop, not main

@mathomp4 mathomp4 self-assigned this Sep 18, 2023
@mathomp4 mathomp4 added 📝 Documentation Improvements or additions to documentation 0 Diff The changes in this pull request have verified to be zero-diff with the target branch. labels Sep 18, 2023
@mathomp4
Copy link
Member

@JulesKouatchou One more thing with this. Could you add to the main README.md with a link or something pointing to the new user guide? I suppose before the Contributing section maybe?

@mathomp4 mathomp4 merged commit 19f57d8 into develop Sep 21, 2023
25 checks passed
@mathomp4 mathomp4 deleted the feature/JK/docs branch September 21, 2023 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 Diff The changes in this pull request have verified to be zero-diff with the target branch. 📝 Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants