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

Contributing documentation to dependencies #5

Open
henrik-wolf opened this issue Mar 14, 2023 · 0 comments
Open

Contributing documentation to dependencies #5

henrik-wolf opened this issue Mar 14, 2023 · 0 comments

Comments

@henrik-wolf
Copy link
Owner

What did we have to figure out ourselves, and how can we help people not having to figure it out themselves in the future, i.e. by adding sections about certain mechanisms in JSServe to their docs.

I, for one do not really enjoy reading long examples in plain julia files or notebooks, since there is always some overhead to either running or displaying them. All the examples in the jsserve folder are really great and very helpful, but I think the docs would gain a lot from having them included as a page.

Additionally, I always feel a lot safer when I have at least a broad understanding of how a library works under the hood. So maybe after figuring this here out, we (or I) could build a short "technical introduction" with a bunch of diagrams and stuff, detailing how things work, what part of the library does what, which keywords to look out for and so on. Just to alleviate the struggle of having to infer the broader ideas and connections from the code alone.

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