Skip to content

Rolling updates to Documentation#1266

Draft
lisancao wants to merge 8 commits intoapache:mainfrom
lisancao:docs_update
Draft

Rolling updates to Documentation#1266
lisancao wants to merge 8 commits intoapache:mainfrom
lisancao:docs_update

Conversation

@lisancao
Copy link
Contributor

@lisancao lisancao commented Dec 26, 2023

What changes were proposed in this pull request?

  • Edit markdown files included in the repository for consistency and readability
  • Change README to be more comprehensive and informative

Why are the changes needed?

  1. Gives users and people learning Gravitino for the first time a better understanding of what it is and how to use it

Fix: # (issue)

Does this PR introduce any user-facing change?

  1. Documentation only, no functionality changes

How was this patch tested?

Not tested but docs can be regenerated for website to test for formatting issues.

Copy link
Member

@justinmclean justinmclean left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a few minor changes.


Gravitino aims to provide several key features:
<details>
<summary> Table of Contents </summary>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use sentence case for consistency

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean in Table of Contents?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean in Table of Contents?

I think "sentence case" means, only the first word use capital case: "Table of contents", instead of "Table of Contents"

@lisancao
Copy link
Contributor Author

Needs a few minor changes.

All have been resolved in newest commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants