dwyl/learn-redux

Add Table of Contents to Notes for easier navigation?

Open

#14 aperta il 6 gen 2016

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)HTML (42 fork)batch import
enhancementhelp wantedquestion

Metriche repository

Star
 (446 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

At the moment the notes are a bit "raw" ... https://github.com/nelsonic/learn-redux/blob/master/egghead.io_video_tutorial_notes.md Would it make sense to add a TOC to help people find the section they need?

Guida contributor

Direzione di ricerca
Il problema suggerisce di aggiungere un Indice al file delle note all'indirizzo https://github.com/nelsonic/learn redux/blob/master/egghead.io video tutorial notes.md. L'indice dovrebbe collegarsi alle intestazioni di sezione nel documento. Per implementarlo, inserire un elenco di collegamenti di ancoraggio all'inizio del file, facendo riferimento agli ID di sezione esistenti o creandoli se necessario. Si tratta di un'attività di documentazione autonoma senza modifiche al codice.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
basic markdown syntax
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80