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

Examples should be updated #1660

Open
hyrodium opened this issue Jul 25, 2021 · 4 comments · May be fixed by #2452
Open

Examples should be updated #1660

hyrodium opened this issue Jul 25, 2021 · 4 comments · May be fixed by #2452

Comments

@hyrodium
Copy link
Contributor

We have examples here, but some of the links seem not good for beginner.

Should we remove these links? If so, I'll fix them in #1659.

@fredrikekre
Copy link
Member

Now that almost all packages use Documenter I feel like the list should either be removed or be curated to only include links to packages that does something extra (custom CSS, examples with Literate, etc).

@hyrodium
Copy link
Contributor Author

Is there any good place to find example documentation?
I thought JuliaHub would be a good place to find packages and documentations, but the most of documentations are deployed on juliahub, and there's no "Edit on GitHub" button.

@mortenpi
Copy link
Member

mortenpi commented Aug 1, 2021

Now that almost all packages use Documenter I feel like the list should either be removed or be curated to only include links to packages that does something extra (custom CSS, examples with Literate, etc).

I agree with this. We could perhaps point to one or two well-maintained packages that do a good job with the docs where people could go and check the basic setup (in addition to the links to packages that are doing something special).

@mortenpi
Copy link
Member

mortenpi commented Aug 1, 2021

That said, in the meanwhile, we can also just make sure that the links we have there are up to date.

@hyrodium hyrodium linked a pull request Feb 15, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants