apache / apache/iotdb

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

Open
#3,383 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
6.4k
Forks
1.2k
Avg merge
1d 23h
Merged PRs (30d)
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)

Contributor guide

Open the contributing guide

Research direction

No source file, test, or entry point is named. Start by inspecting the linked IoTDB website and locating how its Markdown pages are generated; confirm how section headings are represented. Done means long single-page Markdown documents display a right-hand content sidebar linking to their sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.