freeCodeCamp/devdocs

Current page's table of contents

Ouverte

#6 ouverte le 28 oct. 2013

Voir sur GitHubGuide contributeur
 (20 commentaires) (2 réactions) (0 personne assignée)Ruby (2 598 forks)batch import
featurehelp wanted

Métriques du dépôt

Stars
 (38 907 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Direction de recherche
Examinez la structure des pages de documentation DevDocs pour identifier comment les titres (<h2>, <h3>) sont rendus. Consultez le code frontend existant (probablement JavaScript) pour comprendre comment injecter une table des matières en position fixe. Vérifiez la documentation du dépôt ou les fichiers sources comme app/assets/javascripts/ pour la logique de rendu des pages. Envisagez d'implémenter un script qui génère une table des matières à partir des éléments de titre et l'ajoute à la page.
Stack technique
javascriptcsshtml
Domaine
frontend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
HTMLCSSJavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85