-
Notifications
You must be signed in to change notification settings - Fork 384
Improve discoverablility of network models in NEST docs #3428
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
base: master
Are you sure you want to change the base?
Conversation
Pull request automatically marked stale! |
@jhnnsnk ping! |
doc/htmldoc/models/index.rst
Outdated
.. grid:: | ||
|
||
.. grid-item-card:: | ||
:columns: 4 | ||
:link: network_models | ||
:link-type: ref | ||
|
||
**Network Models** | ||
|
||
|
||
|
||
.. grid-item-card:: | ||
:columns: 4 | ||
:link: model_selector | ||
:link-type: ref | ||
|
||
**Neurons, synapses, and devices** |
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.
Instead of these cards, I suggest to start the page with the section "What we mean by models" that is currently further down (https://nest-simulator--3428.org.readthedocs.build/en/3428/models/index.html#what-we-mean-by-models). This section should also mention devices.
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.
This was discussed before, and the decision was made that we want to see the model selector near the top, so this was pushed further down. but maybe we can add a link at the top of the page with the cards like 'what's the difference?'
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.
@jessica-mitchell I think for a new user it might be unclear that the model selector does not refer to network models after showing the cards of both. Yes, the "What's the difference?" already helps. In addition, I suggest to extend "Select a tag to display corresponding models." to "Select a tag to display corresponding neuron, synapse or device models."
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.
Maybe "Neuron, synapse, and device models"?
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.
Technically the devices are not 'models', at least how I understand we define them. I did add some text below in the 'what we mean by models' section to explain a bit more. Hopefully without confusing it more.
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.
Thanks a lot for this PR!
The card on large-scale models in Examples looks good to me.
I've left a comment with the suggestion to reorder the content of the Models page.
On the start page, would it be possible to add links to the examples or sections shown automatically one after the other?
@jhnnsnk reminder
If I understand what you mean, you want to be able to click on the image/text in the carousel and go straight to that example? I don't exactly remember, but there was an issue with doing that. I can look into it again |
Yes, that's what I wanted to say. Thanks for looking into it. |
@jhnnsnk I added links to the images in the carousel, and modified the models/index page text a bit |
Looks and works great, thank you! |
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.
I left some tiny suggestions for text modifications, otherwise it's already great!
doc/htmldoc/models/index.rst
Outdated
:link: network_models | ||
:link-type: ref | ||
|
||
**Network Models** |
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.
Lower-case "models"?
doc/htmldoc/models/index.rst
Outdated
.. grid:: | ||
|
||
.. grid-item-card:: | ||
:columns: 4 | ||
:link: network_models | ||
:link-type: ref | ||
|
||
**Network Models** | ||
|
||
|
||
|
||
.. grid-item-card:: | ||
:columns: 4 | ||
:link: model_selector | ||
:link-type: ref | ||
|
||
**Neurons, synapses, and devices** |
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.
Maybe "Neuron, synapse, and device models"?
This PR adds some additional links for network models in the models directory as well as in the examples
Output on Read the Docs: https://nest-simulator--3428.org.readthedocs.build/en/3428/index.html