dwyl/learn-redux

Add Table of Contents to Notes for easier navigation?

Open

#14 opened on Jan 6, 2016

View on 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?

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic markdown syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.