incubator-devlake icon indicating copy to clipboard operation
incubator-devlake copied to clipboard

[Doc][Documentation] Use hyperlinks to link unlinked Readme.md content to Website

Open keon94 opened this issue 2 years ago • 0 comments

Documentation Scope

Readme.md

Describe the Change

The Readme contains duplicated content from the website (Introduction, Datasources, Create Blueprint, etc). This makes managing it cumbersome (we have to track both places). I suggest we simply link these sections to the website as well, like we have with "Getting Started", to make the Readme content minimal. If we want the Readme to contain actual text content we should look into embedding doc pages from the website rather than duplicating content.

Screenshots

If applicable, add screenshots to help explain your problem.

Additional context

Add any other context about the problem here.

keon94 avatar Sep 15 '22 21:09 keon94