[EPIC] Improvement to docs
Open
epic
- Dominant language
- Java
- Stars
- 3.2k
- Forks
- 935
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 315
Description
### Describe the proposal
The current docs for Gravitino has a lot of repeated and redundant materials. Navigating through the docs is not a pleasant experience, especially for new users. We need to restructure the docs for clarity, conciseness and readability.
### Task list
The list of tasks will be dynamically changed on demand.
- [x] Improve the glossary documentation
- [x] Restructure the getting started tutorial
- [x] Refactor the build guide.
- [x] Restructure the whole documentation hierarchy
- [x] Revise the wide markdown tables to HTML tables (narrow tables can be skipped)
- [x] Ensure all the code snippets in the examples are clean and runnable
Contributor guide
Assessment
This issue has not been assessed yet.