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

use DocumenterVitepress.jl for documentation

Open CarloLucibello opened this issue 1 year ago • 1 comments

It would we nice to have a right pane in doc pages https://fluxml.ai/Flux.jl/dev/reference/models/layers/ so that one can see all layers at a glance and quickly jump to any one of them

With DocumenterVitepress.jl we would have a nice right pane https://luxdl.github.io/DocumenterVitepress.jl

Discussion of right pane for Documenter.jl is in https://github.com/JuliaDocs/Documenter.jl/issues/1688

Alternatives are

  • the creation of an @index https://documenter.juliadocs.org/stable/man/syntax/#@index-block
  • making the docstring collapsed by default setting CollapsedDocStrings = true https://documenter.juliadocs.org/dev/man/syntax/#@meta-block

CarloLucibello avatar Nov 07 '24 06:11 CarloLucibello

One vote against.

If the page listing layers is really too hard to navigate, it can be split up, or given a table of contents. But I'm not convinced it is.

mcabbott avatar Nov 07 '24 08:11 mcabbott