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 (42 forks)batch import
enhancementhelp wantedquestion

Repository metrics

Stars
 (446 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Look at the current notes file and add a table of contents at the top. You can create it manually by listing section headings or use a tool like DocToc to generate one automatically.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90