Add conceptual diagram to NEST docs index page #3176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jessica-mitchell
added
T: Enhancement
|
@jessica-mitchell This looks very nice! In the graphics, I think I'd prefer slightly higher contrast for the "Experimental protocols" and "Data analysis" parts. I will go through the texts in more details shortly. |
|
@jessica-mitchell Great work, Jessica! I agree with HEP to have a bit more contrast for the two panels. Otherwise, the diagram looks very good to me. I also like the text next to the diagram. For the text at the top of the page, I would replace "artificial learning" by "learning", because "artificial" might have connotations to learning mechanisms (such as backprop) in artificial neural networks, while NEST rather provides more biologically plausible learning rules. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a conceptual diagram and associated text to the index page.
Originally we thought to include a mermaid diagram but found a nice-looking alternative with SVG output that was generated from a mermaid -> excalidraw workflow.
The only modification needed to the SVG was to add a target so the links in the diagram can open correctly in new tab.
See Read the Docs output here: https://nest-simulator--3176.org.readthedocs.build/en/3176/