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

Add an overview section to the ProgLearn documentation #441

Merged
merged 5 commits into from
Feb 9, 2021

Conversation

bstraus1
Copy link
Contributor

@bstraus1 bstraus1 commented Feb 9, 2021

Reference issue

Closes #424

Type of change

Documentation

What does this implement/fix?

Add an overview section (as in the Verde documentation)

Copy link
Member

@PSSF23 PSSF23 left a 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?

@bstraus1
Copy link
Contributor Author

bstraus1 commented Feb 9, 2021

@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.

@PSSF23
Copy link
Member

PSSF23 commented Feb 9, 2021

@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.

@bstraus1
Copy link
Contributor Author

bstraus1 commented Feb 9, 2021

Sure. Or, let me know what to do. Either way works.

@PSSF23 PSSF23 requested a review from sampan501 February 9, 2021 06:16
@PSSF23
Copy link
Member

PSSF23 commented Feb 9, 2021

@sampan501 Does the current overview satisfy your needs?

@PSSF23 PSSF23 merged commit 0fb86e8 into neurodata:staging Feb 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sub-issue of #423 (Match Proglearn Documentation to Verde): Add Overview section
3 participants