[Docs] Reorganize the documents to adapt website building

apache / incubator-graphar

An open source, standard data file format for graph data storage and retrieval.

https://graphar.apache.org/

Apache License 2.0

195 stars 40 forks source link

[Docs] Reorganize the documents to adapt website building #448

Closed acezen closed 2 months ago

acezen commented 2 months ago

Proposed changes

Since we have created a repository incubator-graphar-website as our website repo, we should clean the original website page related code from here and only remain the dev documents of the project core(including format, libraries) . So the changes of this Pull Request includes:

Remove the website page related code.
Convert the dev documents from RST to MarkDown and reorganize them.
Refine the Docs CI base on the website building workflow.

The website now looks like:

Further comments

related #432

acezen commented 2 months ago

cc/ @lixueclaire @Thespica @SemyonSinchenko This pull request make a lot of change to the document, may need your review.

acezen commented 2 months ago

The path has been replaced with relative path, and I add a TODO for add markdown lint and typo check CI, please review again, thanks~

Thespica commented 2 months ago

Hi, @acezen the change itself is LGTM.

But when I try to build locally and take a look, I find it a little bit bothering. Can you write some letters that teach how to build documents locally in docs/README.md or docs for developers?

acezen commented 2 months ago

Hi, @acezen the change itself is LGTM.

But when I try to build locally and take a look, I find it a little bit bothering. Can you write some letters that teach how to build documents locally in docs/README.md or docs for developers?

hi,@Thespica, I have put the instruction how to build docs in apache-incubator-website README(they share the same process) and would merge after this PR. The docs/README would have a link to it.