Documenter.jl icon indicating copy to clipboard operation
Documenter.jl copied to clipboard

Examples should be updated

Open hyrodium opened this issue 4 years ago • 4 comments

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.

hyrodium avatar Jul 25 '21 13:07 hyrodium

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).

fredrikekre avatar Jul 25 '21 17:07 fredrikekre

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.

hyrodium avatar Jul 27 '21 14:07 hyrodium

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 avatar Aug 01 '21 07:08 mortenpi

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

mortenpi avatar Aug 01 '21 07:08 mortenpi