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

Modify doc index page #3066

Merged
merged 24 commits into from
Mar 4, 2024
Merged

Conversation

jessica-mitchell
Copy link
Contributor

This PR is taking over for #2969 but being split into multiple PRs so better organized and easier to review.

This PR improves the overall landing page and structure of contents.

Resolves #2783

The new index page

  • It removes the index.html template in favour of a restructured text page, which will eliminate issues with compatibility between the sphinx_material theme and custom template.
  • contains a 'carousel' where we can highlight new and interesting examples. (TODO, decide on which examples to showcase)
  • contains a modified table of contents (TOC)
  • contains a conceptual diagram using elements from NEST Desktop and images courtesy of A. Fischer TODO: Add description to diagram
  • A 'get started here' button leads to the new tutorials and guides section, which is what is seen on the TOC

NOTE changes to other pages will be done in subsequent PRs! The modifications done for tutorial and guide index are interim changes.

@jessica-mitchell jessica-mitchell added T: Enhancement New functionality, model or documentation 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) labels Jan 17, 2024
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Jan 17, 2024
@clinssen
Copy link
Contributor

Cheers!

Should this point still be handled in this PR? "TODO: Add description to diagram"

doc/htmldoc/conf.py Outdated Show resolved Hide resolved
doc/htmldoc/static/css/custom.css Outdated Show resolved Hide resolved
doc/htmldoc/static/css/custom.css Outdated Show resolved Hide resolved
doc/htmldoc/static/css/custom.css Outdated Show resolved Hide resolved
doc/htmldoc/static/img/arrow_left.svg Outdated Show resolved Hide resolved
@jessica-mitchell
Copy link
Contributor Author

@clinssen thanks for your initial comments, I removed the commented out lines, and fixed the svg

@jessica-mitchell jessica-mitchell moved this from In progress to Review in Documentation Jan 26, 2024
@jessica-mitchell
Copy link
Contributor Author

Here are the following changes that were made after our mini doc-a-thon. Thanks for all your feedback
@steffengraber @heplesser @clinssen @ddahmen

See output here

Changes made:

  • Add attribution link
  • Add acknowledgments to community
  • remove 3 buttons on top
  • reduce height of top section
  • change image nest::docs to nest::simulator
  • PyNEST API --> Python API
  • Available Models --> Models
  • Remove conceptual approach: TO BE DISCUSSED
  • Move 'cite NEST' and 'license' to USAGE
  • Add ebrains / hbp logos to footer
  • Local toc "Contents" --> Page contents
  • Change title
  • keep size of carousel images the same
  • use indicators in carousel instead of arrows and change caption
  • TO BE DISCUSSED: specific examples in carousel and/or general features (like types of plasticity)?
  • Changed the name to 'NEST docs home' on breadcrumb trail to make it slightly different from 'NEST Simulator Documentation' text

What did not change, but was discussed:

  • The top bar that displays 'NEST Simulator Documentation' and the global toc 'NEST Simulator Documentation' remain as is (These two are tied to the same variable in conf.py so they can only be modified independently via CSS.). But the main reason they stay is because this top bar is responsive and the text changes on scroll to update to the current heading of visible page. And the global toc is always visible, and having this link there will allow users to always be able to click back to the home page no matter where they are on page.

@clinssen
Copy link
Contributor

Hi, thanks for the updates! This looks mostly fine to me, I propose we merge this and then take it from there.

There seems to be a rendering issue on https://nest-simulator--3066.org.readthedocs.build/en/3066/attribution-list.html

Could we make the EBRAINS/HBP links on the bottom clickable? What about the EU flag?

@jessica-mitchell
Copy link
Contributor Author

Hi, thanks for the updates! This looks mostly fine to me, I propose we merge this and then take it from there.

There seems to be a rendering issue on https://nest-simulator--3066.org.readthedocs.build/en/3066/attribution-list.html

Could we make the EBRAINS/HBP links on the bottom clickable? What about the EU flag?

@clinssen
I made the hbp/ebrains logo clickable, (it is a single image though so it links to ebrains.eu)
I don't know if/where the EU logo would be linked to.
I updated the attribution-list to make it a bit nicer

@heplesser heplesser self-requested a review March 1, 2024 13:54
Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

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

@jessica-mitchell Thanks a lot, this looks very nice now. I found one tiny details, see inline comment, but approve already now.

@jessica-mitchell jessica-mitchell merged commit ffce3b3 into nest:master Mar 4, 2024
24 checks passed
Documentation automation moved this from Review to Done Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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: Enhancement New functionality, model or documentation
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

Docs landing page should showcase examples
3 participants