freeCodeCamp/devdocs

Current page's table of contents

Open

#6 ouverte le 28 oct. 2013

Voir sur GitHub
 (20 commentaires) (2 réactions) (0 assignés)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.).

Guide contributeur

Stack technique
javascripthtmlcss
Domaine
documentationfrontend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
HTMLCSSJavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65
Direction de recherche
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.