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.

Sign up for GitHub

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

Jump to bottom

Update documentation organisation and landing page #2784

Merged
merged 3 commits into from
Jun 22, 2023
Merged

Update documentation organisation and landing page #2784

merged 3 commits into from
Jun 22, 2023

Conversation

clinssen
Copy link
Contributor

  • Makes top-line (white) buttons navigate across documentation resources: NEST Initiative; other tools; contact/support
  • Bundles second-line (orange) buttons and removes undifferentiated external link to NESTML (this needs more introduction and thus links into the models doc page now)
  • Add a little introductory text at the very top of the landing page so people new to NEST know what they are looking at

All of these changes probably need some more fine-tuning and discussion!

@clinssen clinssen added T: Discussion Still searching for the right way to proceed / suggestions welcome ZC: Documentation DO NOT USE THIS LABEL labels May 13, 2023
@clinssen clinssen added this to In progress in Documentation via automation May 13, 2023
jessica-mitchell
jessica-mitchell requested changes May 23, 2023
View reviewed changes
Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@clinssen thanks for these suggestions, they are definitely an improvement. I have a couple of comments.
We're still looking at additional changes to the doc webpage but I dont see any major issue with the changes you've made.

doc/htmldoc/templates/index.html Outdated Show resolved Hide resolved
doc/htmldoc/templates/index.html Outdated Show resolved Hide resolved
doc/htmldoc/templates/index.html Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review May 23, 2023
@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) and removed ZC: Documentation DO NOT USE THIS LABEL labels May 24, 2023
jessica-mitchell
jessica-mitchell approved these changes Jun 22, 2023
View reviewed changes
Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jessica-mitchell
Copy link
Contributor

merging with 1 revierer as its doc related

@jessica-mitchell jessica-mitchell merged commit 228756c into nest:master Jun 22, 2023
20 checks passed
Documentation automation moved this from Review to Done Jun 22, 2023
@terhorstd terhorstd added T: Maintenance Work to keep up the quality of the code and documentation. and removed T: Discussion Still searching for the right way to proceed / suggestions welcome labels Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jessica-mitchell jessica-mitchell jessica-mitchell approved these changes

Assignees
No one assigned
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@clinssen @jessica-mitchell @terhorstd