-
Notifications
You must be signed in to change notification settings - Fork 42
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
Add an overview section to the ProgLearn documentation #441
Conversation
Pulled updates from Staging
Add an overview section (as in the [Verde](https://www.fatiando.org/verde/latest/tutorials/overview.html) documentation)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bstraus1 This change does not make sense to me. We have the overview already as the index page, so why don't you add your changes there?
@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. |
@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. |
Sure. Or, let me know what to do. Either way works. |
@sampan501 Does the current overview satisfy your needs? |
Reference issue
Closes #424
Type of change
Documentation
What does this implement/fix?
Add an overview section (as in the Verde documentation)