apache / apache/iotdb

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

Ouverte
#3,383 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
Java
Étoiles
6.4k
Forks
1.2k
Merge moyen
1 j 23 h
PR mergées (30 j)
115

Description

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)

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Aucun fichier source, test ou point d’entrée n’est indiqué. Commencez par examiner le site web IoTDB indiqué par le lien et déterminer comment ses pages Markdown sont générées ; confirmez comment les titres de section sont représentés. Le travail est terminé lorsque les longs documents Markdown sur une seule page affichent une barre latérale de contenu à droite qui renvoie vers leurs sections.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown
Domaine
documentation, web-dev
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.