apache / apache/iotdb

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

Aperta
#3,383 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
Java
Stelle
6.4k
Fork
1.2k
Merge medio
1g 23h
PR unite (30g)
115

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Non viene indicato alcun file sorgente, test o punto di ingresso. Inizia esaminando il sito web IoTDB collegato e individuando come vengono generate le sue pagine Markdown; conferma come vengono rappresentati i titoli delle sezioni. Il lavoro è completato quando i lunghi documenti Markdown a pagina singola mostrano una barra laterale dei contenuti sulla destra che collega alle relative sezioni.

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

Valutazione

Stack tecnologico
markdown
Ambito
documentation, web-dev
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.