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

online docs on juliahub - up to date/duplicate? #7

Closed
thejasvibr opened this issue Mar 21, 2024 · 1 comment
Closed

online docs on juliahub - up to date/duplicate? #7

thejasvibr opened this issue Mar 21, 2024 · 1 comment

Comments

@thejasvibr
Copy link

Hi,
This is in relation to openjournals/joss-reviews#6390.

There seems to be online documentation that's not mentioned in the Github repo's README. Found it through a quick online search, and other future users may potentially do so too - and thus the question.

Is this online docs page up to date - or was it a trial that was not completed. It seems like some parts of the README and example notebook are online currently. In my opinion, an online docs page is way more convincing than a user having to open up Jupyter Lab, wait for it all to open, and then open a notebook file. A nice online docs page is a reliable indicator into how user-friendly a package is, and can attract potential users to install the package and try it out themselves.

The decision to keep an online docs or not is up to you of course. Either way, it would be good to either take down the page if there's no plan to keep it up to date, or go all in and make it detailed enough to be useful.

@1oly
Copy link
Owner

1oly commented Apr 10, 2024

Hi, and thanks for the comment!
This should be a little clearer with #10
I typically just push the badge, so didn't think about writing it.

When the package is registered in the julia metadata, the docs are copied to juliahub. These are simply the same as the ones in this repo. It's not the most elaborate docs, but I intend to add some more examples.

@1oly 1oly closed this as completed Apr 10, 2024
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

2 participants