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

[FEATURE] Unify JuliaHealth Documentation Like SciML's Documentation #123

Open
TheCedarPrince opened this issue Dec 19, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@TheCedarPrince
Copy link
Member

I absolutely adore the attempt at unified documentation like in the SciML ecosystem. The source code is here: https://docs.sciml.ai/Overview/stable/

I have no idea how they really did it, but I think it is a fantastic idea and wish that we could start something similar within JuliaHealth. I think the first step might be to start with MultiDocumenter.jl. Although I am not fully certain myself.

@TheCedarPrince TheCedarPrince added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Dec 19, 2023
@TheCedarPrince
Copy link
Member Author

Hey @sneha9231,

Following on our discussion from Slack, here are some thoughts on this issue from an abridged conversation I had with @Jay-sanjay:

And to me, I haven't explored MultiDocumenter that much yet, [but] MultiDocumenter coalesces all the documentation for each [individual] package [you select] together [into one] glued together [documentation site]. I think what's nice about it is that it keeps documentation per package separate and then we can update the MultiDocumenter site perhaps once a day to keep track of any new changes [across the JuliaHealth ecosystem].

As you can tell, I am quite a fan of Multidocumenter for addressing this issue potentially! I am happy to work with you on a prototype for this Sneha so let me know if you have any questions -- I think it would help quite a lot with getting more traction for JuliaHealth!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
Development

No branches or pull requests

1 participant