freeCodeCamp/devdocs

Current page's table of contents

Open

#6 aperta il 28 ott 2013

Vedi su GitHub
 (20 commenti) (2 reazioni) (0 assegnatari)Ruby (2598 fork)batch import
featurehelp wanted

Metriche repository

Star
 (38.907 star)
Metriche merge PR
 (Merge medio 23g 15h) (7 PR mergiate in 30 g)

Descrizione

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.).

Guida contributor

Direzione di ricerca
Esamina la struttura della pagina delle pagine di documentazione di DevDocs per identificare come vengono renderizzati i titoli (<h2>, <h3>). Osserva il codice frontend esistente (probabilmente JavaScript) per capire come iniettare un sommario a posizione fissa. Controlla la documentazione del repository o i file sorgente come app/assets/javascripts/ per la logica di rendering della pagina. Considera l'implementazione di uno script che genera un sommario dagli elementi di intestazione e lo aggiunge alla pagina.
Tech stack
javascriptcsshtml
Dominio
frontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
HTMLCSSJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85