playframework/playframework

Automatically generate table of contents for certain docs

Offen

#7.917 geöffnet am 10.10.2017

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Scala (4.032 Forks)batch import
help wantedtopic:documentation

Repository-Metriken

Stars
 (12.623 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 10T 17h) (69 gemergte PRs in 30 T)

Beschreibung

Some pages of documentation (see dependency-injection docs for example) are especially long with multiple subheadings. Rather than split them all into separate pages or have to manually create/edit the ToC, it would be nice to have a way of automatically generating the ToC in certain pages.

Contributor Guide

Research-Richtung
Die Play Framework Dokumentation wird aus Markdown Dateien im Verzeichnis 'docs' generiert. Um ein automatisches Inhaltsverzeichnis zu implementieren, könnte man ein Tool wie 'markdown toc' oder 'doctoc' in den Build Prozess integrieren. Überprüfen Sie die vorhandenen Dokumentations Build Skripte (wahrscheinlich sbt basiert) und fügen Sie einen Schritt hinzu, der ein Inhaltsverzeichnis für Seiten mit mehreren Überschriften generiert. Das Issue ist seit 2017 offen und hat keine Kommentare, daher wäre es gut, zunächst den aktuellen Dokumentationsgenerierungsprozess zu untersuchen.
Tech Stack
Keine
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80