Skip to content

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

jessica-mitchell
Copy link
Contributor

@jessica-mitchell jessica-mitchell commented Mar 20, 2025

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

@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Mar 20, 2025
@github-project-automation github-project-automation bot moved this to In progress in Documentation Mar 20, 2025
@github-project-automation github-project-automation bot moved this from In progress to Done in Documentation Mar 20, 2025
@github-project-automation github-project-automation bot moved this from Done to In progress in Documentation Mar 20, 2025
Copy link

Pull request automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label May 26, 2025
@jessica-mitchell
Copy link
Contributor Author

@jhnnsnk ping!

@github-actions github-actions bot removed the stale Automatic marker for inactivity, please have another look here label Jul 1, 2025
Comment on lines 13 to 29
.. 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**
Copy link
Contributor

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.

Copy link
Contributor Author

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?'

Copy link
Contributor

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

Copy link
Contributor

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"?

Copy link
Contributor Author

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.

Copy link
Contributor

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

@github-project-automation github-project-automation bot moved this from In progress to Review in Documentation Aug 11, 2025
@jessica-mitchell
Copy link
Contributor Author

@jhnnsnk reminder

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?

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

@jhnnsnk
Copy link
Contributor

jhnnsnk commented Aug 14, 2025

@jhnnsnk reminder

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?

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.

@jessica-mitchell
Copy link
Contributor Author

@jhnnsnk I added links to the images in the carousel, and modified the models/index page text a bit

@jhnnsnk
Copy link
Contributor

jhnnsnk commented Aug 19, 2025

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

Copy link
Contributor

@jhnnsnk jhnnsnk left a 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!

:link: network_models
:link-type: ref

**Network Models**
Copy link
Contributor

Choose a reason for hiding this comment

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

Lower-case "models"?

Comment on lines 13 to 29
.. 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**
Copy link
Contributor

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"?

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: Maintenance Work to keep up the quality of the code and documentation.
Projects
Status: Review
Development

Successfully merging this pull request may close these issues.

2 participants