JuliaDocs/Documenter.jl

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

Open

#1.986 geöffnet am 2. Dez. 2022

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository-Metriken

Stars
 (910 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche, wie der Suchindex Abschnittsnamen anzeigt, und repliziere diese Logik im Code zur Generierung des manuellen Index.
Tech Stack
julia
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60