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

Improve docs for guides and getting started #3068

Merged
merged 19 commits into from
Mar 7, 2024

Conversation

jessica-mitchell
Copy link
Contributor

This PR builds on #3066 focusing on the organization of the guides and tutorials - here the various 'guides' are organized with an initial section for beginners continuing to various topics that would be helpful for the majority of users who are relatively new to NEST. Additional guides are included after.
Can only be merged once #3066 is merged

@jessica-mitchell jessica-mitchell added T: Enhancement New functionality, model or documentation P: Blocked Work on this can not continue, see comments for the particular reason 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
@jessica-mitchell
Copy link
Contributor Author

Please check the 'Next steps' section as I tried to put the topics logically together in some cases. I was trying to avoid having too many cards.

@clinssen @ddahmen @heplesser @steffengraber

See output here

Changes made

  • have 3 sections
  • CHANGE next steps: Create you own network model
  • create models --> create neuron, synapse, devices

Move the following to 'next steps'

  • random numbers

  • stimulate the network

  • spatially structured

  • guide to parallel computing

  • remove see also

  • add examples card in next steps

  • large scale models (brunel, microcircuit, meso, mam)
    NOTE: put large scale models in 'next steps', unsure if that was where we discussed it should go / also not sure about Brunel - I added one example from nest

  • built in timers --> go to hpc

  • nest sonata --> connect to other tools

  • Changed button on index page that links to this page to "start exploring nest" rather than 'get started' since it focuses on the topcis of nest where as 'getting started' kind of implies that it includes installation

  • added new icons

  • remove unused icons

TODO
add an example from spatially structured networks to large scale models

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 This looks very good now! The "Large networks" box is a bit tall, but I don't see any way around that.

@heplesser heplesser requested a review from ddahmen March 1, 2024 14:10
@jessica-mitchell jessica-mitchell removed the P: Blocked Work on this can not continue, see comments for the particular reason label Mar 4, 2024
@ddahmen
Copy link
Contributor

ddahmen commented Mar 7, 2024

@jessica-mitchell Great work! Apart from the typo "how random number" -> "how random numbers" in the "Simulate your network" box, everything looks perfect to me.

@jessica-mitchell jessica-mitchell merged commit 412cc7a into nest:master Mar 7, 2024
24 checks passed
Documentation automation moved this from In progress to Done Mar 7, 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.

None yet

3 participants