JuliaDocs/Documenter.jl

Enhance at-index to list section names, like the search index

Open

#1,986 opened on Dec 2, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

At https://docs.oscar-system.org/dev/search/?q=dim I see a long list of matches for dim, but I can separate them quite well because most are in different sections and the section titles are shown.

But on the regular index at https://docs.oscar-system.org/dev/manualindex I only see the long list of dim, repeated many times -- but no hint as to where the various dim come from.

Would it be possible to enhance the index there to match the search index, i.e., to show

dim (method, Polyhedral Complexes)

and not just

dim

?

(Even better would be of course if I could also show the signature, see issue #1038)

Contributor guide

Research direction
Examine how the search index displays section names and replicate that logic in the manual index generation code.
Tech stack
julia
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60