Add a table of contents page on every documentation.
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 30/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Attiva
- Ambito
- documentation
Direzione di ricerca
Non vengono indicati file, test o punti di ingresso. Inizia leggendo la visione del README e verificando come è strutturata la documentazione del linguaggio e del framework del progetto; il lavoro è terminato quando ogni documentazione ha un indice concordato che copre il materiale introduttivo fino ai riferimenti per funzioni o classi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Feature request
I am suggesting a table of contents on each documentation.
Summary
The table of contents should start with entry into the language or framework, then functional or class reference of it.
This will make sure that everyone getting started on a language has a clear flow of knowledge from easy to expert, then for the experts, functional reference list will be a plus
Examples
lets say we want to create a table of contents for html:
Table of Contents: HTML
What is html ........................................................ 1
Evolution of HTML ............................................ 2
some feature ....................................................... n
Functional References
function one ......................................................... n +2
- Lingua principale
- Ruby
- Stelle
- 39.5k
- Fork
- 2.6k
- Merge medio
- 2g 9h
- PR unite (30g)
- 13
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di freeCodeCamp/devdocs
-
class Data in Ruby 3.2 Apertadocs/improvement
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
freeCodeCamp/devdocs#1989 · 4 commenti · 4 reazioni ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
freeCodeCamp/devdocs#2712 ·
-
Unit test frontend code Apertafeature
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
freeCodeCamp/devdocs#2673 ·
-
feature
Difficoltà 5/5 Più di una settimana Idoneità per principianti 18/100
freeCodeCamp/devdocs#2669 · 3 commenti · 3 reazioni ·
Tutte le issue di freeCodeCamp/devdocs
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Please Drop ruby 3.2 support Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
googleapis/google-api-ruby-client#28001 · 5 reazioni ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100