Skip to content

[EPIC] Improvement to docs #6600

Open
Open
@tengqm

Description

@tengqm

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.

  • Improve the glossary documentation
  • Restructure the getting started tutorial
  • Refactor the build guide.
  • Restructure the whole documentation hierarchy
  • Revise the wide markdown tables to HTML tables (narrow tables can be skipped)
  • Ensure all the code snippets in the examples are clean and runnable

Metadata

Metadata

Assignees

Labels

epicKey feature

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions