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

Add "Further reading" sections in documentation #676

Closed
TorkelE opened this issue Sep 17, 2023 · 3 comments
Closed

Add "Further reading" sections in documentation #676

TorkelE opened this issue Sep 17, 2023 · 3 comments

Comments

@TorkelE
Copy link
Member

TorkelE commented Sep 17, 2023

For several documentation pages that explain how to perform certain analysis (bifurcation diagrams, performing Gillespie simulations), would it make sense to have a further reading section at the end, providing references to articles/text books? That way, someone interested in the topic can quickly find a source of in-depth reading. Alternatively, someone not familiar with the topic might a first place to read up on it.

@TorkelE
Copy link
Member Author

TorkelE commented Sep 17, 2023

Similarly, maybe some sections maybe should have a "Citation" section with papers people should cite if they use that functionality? E.g. https://link.springer.com/chapter/10.1007/978-3-319-96418-8_54 for https://docs.sciml.ai/Catalyst/stable/catalyst_applications/homotopy_continuation/.

@TorkelE
Copy link
Member Author

TorkelE commented Sep 17, 2023

(for certain doc pages, similarily exist, but called "References". We could also use that name for the proposed section)

@TorkelE
Copy link
Member Author

TorkelE commented Nov 9, 2023

This kinds of sections (in references) have now been added where suitable.

@TorkelE TorkelE closed this as completed Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant