freeCodeCamp/devdocs

Current page's table of contents

Open

#6 opened on Oct 28, 2013

View on GitHub
 (20 comments) (2 reactions) (0 assignees)Ruby (2,598 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (38,907 stars)
PR merge metrics
 (Avg merge 23d 15h) (7 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Implement a fixed position table of contents that automatically generates from page headings (h2, h3, etc.). Use JavaScript to scan the page, extract headings, and build a navigable ToC element with smooth scrolling.
Tech stack
javascriptcsshtml
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
HTMLCSSJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85