Add an overview section to the ProgLearn documentation#441
Merged
Conversation
Pulled updates from Staging
Add an overview section (as in the [Verde](https://www.fatiando.org/verde/latest/tutorials/overview.html) documentation)
Contributor
Author
|
@sampan501 asked for a separate overview section (that is not a landing page) and follows the format of the Verde documentation. I agree that it has some redundancies, but also appreciate the point @sampan501 made saying that this will say the essential info not covered in the landing page. |
Member
|
@bstraus1 I see. Then substantial differentiation should be made. The true overview should not contain indices or badges, and the landing page would remove the "overview" terms. No sentences should be repeated. I can modify them if you wish. |
Contributor
Author
|
Sure. Or, let me know what to do. Either way works. |
PSSF23
approved these changes
Feb 9, 2021
Member
|
@sampan501 Does the current overview satisfy your needs? |
sampan501
approved these changes
Feb 9, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reference issue
Closes #424
Type of change
Documentation
What does this implement/fix?
Add an overview section (as in the Verde documentation)