Allow pinning certain sections in documentation
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- ruby
- Bereich
- documentation, frontend
Rechercherichtung
Beginne mit der Prüfung der DevDocs-Vision in README.md und untersuche anschließend, wie Dokumentationsabschnitte derzeit in Sets wie C++ und CSS dargestellt werden. Kläre, wie angeheftete Abschnitte pro Dokumentationsset gespeichert werden und wie die Reihenfolge funktionieren soll; als abgeschlossen gilt die Aufgabe, wenn ein Benutzer einen Abschnitt anheften und ihn auf passenden Seiten oben sehen kann, ohne andere Dokumentationssets zu beeinflussen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Ruby
- Sterne
- 39.6k
- Forks
- 2.7k
- Ø Merge
- 1 T. 22 Std.
- Gemergte PRs (30 T.)
- 15
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus freeCodeCamp/devdocs
-
class Data in Ruby 3.2Offendocs/improvement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
freeCodeCamp/devdocs#1989 · 4 Kommentare · 4 Reaktionen ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 8/100
freeCodeCamp/devdocs#2746 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
freeCodeCamp/devdocs#2744 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
feature
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
freeCodeCamp/devdocs#2712 ·
Maintainer antworten meist innerhalb von 1 Tag
-
feature
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100
freeCodeCamp/devdocs#2683 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in freeCodeCamp/devdocs
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 72/100
TheOdinProject/curriculum#31479 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 67/100
taskcluster/taskcluster#9284 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Class option relations are appended to the command on every runEvtl. vergeben @auraseb hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100