freeCodeCamp/devdocs

Current page's table of contents

Offen

#6 geöffnet am 28.10.2013

Auf GitHub ansehenContributor Guide
 (20 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Ruby (2.598 Forks)batch import
featurehelp wanted

Repository-Metriken

Stars
 (38.907 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Some documentations have very long pages that are difficult to browse through. We could improve this by adding a fixed-positioned table of contents which is automatically generated based on the current page's headings (<h2>, <h3>, etc.).

Contributor Guide

Research-Richtung
Untersuche die Seitenstruktur der DevDocs Dokumentationsseiten, um zu ermitteln, wie Überschriften (<h2>, <h3>) gerendert werden. Sieh dir den vorhandenen Frontend Code (wahrscheinlich JavaScript) an, um zu verstehen, wie ein fixiert positioniertes Inhaltsverzeichnis eingefügt werden kann. Überprüfe die Dokumentation des Repositorys oder Quelldateien wie app/assets/javascripts/ auf die Seitenrendering Logik. Erwäge die Implementierung eines Skripts, das aus den Überschriftenelementen ein Inhaltsverzeichnis generiert und es zur Seite hinzufügt.
Tech Stack
javascriptcsshtml
Domain
frontend
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.
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
HTMLCSSJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85