Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Allow pinning certain sections in documentation

Aperta
#2,509 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
ruby
Ambito
documentation, frontend

Direzione di ricerca

Inizia esaminando la visione di DevDocs in README.md, quindi analizza come vengono attualmente presentate le sezioni della documentazione in set come C++ e CSS. Chiarisci come vengono memorizzate le sezioni fissate per ciascun set di documentazione e come dovrebbe funzionare l’ordinamento; il lavoro è completo quando un utente può fissare una sezione e visualizzarla in cima alle pagine corrispondenti senza influire sugli altri set di documentazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

feature

Feature request

Summary

In documentations a lot of times there are sections that consistently exist across most pages of the docs, for instance in the C++ documentation a lot of times you find that there is an Examples section that shows how to use the function being documented. I would really like to have the example section appear on the top of the page because a lot of times it does a much better job at explaining what the function does and how to use it than the cppreference cryptic definitions.

Examples

I don't have a screenshot of this feature from another source. I think having a pin button next to the sections is a good starting point. When that button is clicked, the section should be added to a list of pinned sections, and whenever the visited page contains that section, it should be displayed at the top of the page. Of course, the pinned sections will be local to each set of docs, so if you pin the Examples section in the C++ docs, it won't be pinned in the CSS docs. This is both simpler to implement and makes sense, since each documentation set has its own structure.

I think this is a solid foundation to build on. From there, you could refine it further, perhaps by adding a settings section in each set of docs where you can view all available sections in those docs and allow the user to drag and drop them into a list to define their preferred order. However, this would 1) be quite challenging to implement and 2) may not be practical in reality.

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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di freeCodeCamp/devdocs

Tutte le issue di freeCodeCamp/devdocs

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.