apache / incubator-graphar

An open source, standard data file format for graph data storage and retrieval.
https://graphar.apache.org/
Apache License 2.0
192 stars 40 forks source link

feat(CI):enable markdownlint and typos in docs.yml #508

Open ywh555hhh opened 1 month ago

ywh555hhh commented 1 month ago

Improve CI flow, for docs.yml, enable markdownlint and typos

Reason for this PR

to fix issue #499

What changes are included in this PR?

enable markdownlint and typos in docs.yml

Are these changes tested?

no local test

Are there any user-facing changes?

no

SemyonSinchenko commented 1 month ago

May we also make a script for do that before commit? For example, in folder ./dev something like fix_spelling.sh?

ywh555hhh commented 1 month ago

I'll try to fix it automatically with markdownlint

ywh555hhh commented 2 weeks ago

When using Markdownlint for document formatting checks, I encountered some issues that could not be automatically resolved, mainly involving a large number of MD013 (line length is too long) and MD033 (inline HTML) issues, as well as one MD025 (multiple top-level headings) issue.

For example, I encountered MD013 and MD033 issues on line 110 of the specification/format.md file, and an MD025 issue in the libraries/cpp/getting-started.md file.

To resolve these issues, I have configured Markdownlint to ignore these three types of issues in the .markdownlint.yaml configuration file. The specific configuration is as follows:

# Ignore MD013, as the document requires longer lines to maintain the integrity of code examples
MD013: false

# Ignore MD033, as inline HTML is necessary in some cases, such as specific formatting requirements
MD033: false

# Ignore MD025, as the document structure requires multiple top-level headings to reflect different sections or parts
MD025: false

I believe this is a reasonable solution because these issues are mainly caused by the mismatch between our document format and the default rules of Markdownlint. By customizing our Markdownlint configuration, we can ensure that it better adapts to our document structure and formatting needs.

ywh555hhh commented 5 days ago

Hi, @ywh555hhh, it seems that the markdown format work, but there still some format error in CI, could you help to fix them? then the PR can be merged.

I expect to have time to deal with it next week