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 (38,907 stars) (2,598 forks)batch import
featurehelp wanted

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

Tech stack
javascripthtmlcss
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
HTMLCSSJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the page structure of DevDocs documentation pages to identify how headings (<h2>, <h3>) are rendered. Look at existing frontend code (likely JavaScript) to understand how to inject a fixed positioned table of contents. Check the repository's documentation or source files like app/assets/javascripts/ for page rendering logic. Consider implementing a script that generates a TOC from heading elements and adds it to the page.