dwyl/learn-redux

Add Table of Contents to Notes for easier navigation?

Open

#14 aberto em 6 de jan. de 2016

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (446 stars) (42 forks)batch import
enhancementhelp wantedquestion

Description

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?

Guia do colaborador

Pilha de tecnologia
None
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
basic markdown syntax
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80
Direção de pesquisa
The issue suggests adding a Table of Contents to the notes file at https://github.com/nelsonic/learn redux/blob/master/egghead.io video tutorial notes.md. The TOC should link to section headers in the document. To implement, insert a list of anchor links at the top of the file, referencing existing section IDs or creating them if needed. This is a standalone documentation task without code changes.