apache / apache/iotdb

Add the content sidebar of a singe markdown file to the website

Offen
#3,383 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
6.4k
Forks
1.2k
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
115

Beschreibung

Now the IoTDB [website](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html) has the left sidebar to guide through different markdown files,
but lacks the right sidebar to guide through the different sections in a single markdown file.
It's easy to get lost when reading a long markdown without a content sidebar.
![image](https://user-images.githubusercontent.com/33376433/121475237-ba061d00-c9f7-11eb-8227-34e6dc647af5.png)
![image](https://user-images.githubusercontent.com/33376433/121475750-67793080-c9f8-11eb-8d16-644b3839cd35.png)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Es wird keine Quelldatei, kein Test und kein Einstiegspunkt genannt. Beginne damit, die verlinkte IoTDB-Website zu untersuchen und herauszufinden, wie ihre Markdown-Seiten generiert werden; bestätige, wie Abschnittsüberschriften dargestellt werden. Als abgeschlossen gilt die Aufgabe, wenn lange einseitige Markdown-Dokumente eine Inhaltsseitenleiste auf der rechten Seite anzeigen, die auf ihre Abschnitte verlinkt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
documentation, web-dev
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.