nest-simulator
nest-simulator copied to clipboard
nest
Add conceptual diagram to NEST docs index page
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/
@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.
Thanks a lot, Jessica. The sketch looks good to me now. I still would remove the word "artificial" in the text (see comment above). Otherwise, I am fine with the PR.
@heplesser I applied the changes you requested, and I added a horizontal version of the diagram along with the vertical so you can compare
Thanks! I prefer the horizontal version, with the headline above the figure and the text below.
@heplesser I modified the svg slightly - can you check Safari to see if it fixed the problem? I do not have a mac to test on at the moment.
@heplesser Ok I think I solved the issue: setting the height to a specific px height fixed the problem on Safari. Can you check? But because now it's a specific height, it has to be adjusted for different screens. Right now I have it default to 400px, and for screens less than 768px wide the height is adjusted to 200px, which seemed to look decent when I inspected the devices on Firefox.