Origami [Docs] Refinement of Readme.md

[Docs] Refinement of Readme.md

Open vasudev-sharma opened this issue 4 years ago • 3 comments

I saw a lot of PR's and issues on readme doc. Some of them have been partially completed and some have been not been reviewed or merged. Moreover, some of the PR's related to readme have became outdated and stale because of contributions made by the past developers had made them irrelevant due to recent changes.

Hence,I think we should formulate a clear and systematic approach to properly document readme doc.

Description

First, I would like to point some issues regarding documentation under the heading Installing Docker, I believe from a point of installation, this documentation is quite unstructured. A structured approach ( either in the form of bullets or numerals ) would give more clarity and sense.

Additionally there should be proper referencing of the instructions given under Installing Docker. For example skip step 3 should be referencing to docker installation step 3 url page.

Secondly, I think when a user clicks under windows installation guidelines given in the readme doc, it makes the doc too long. I believe we should redirect it to another documentation file related to windows installation guidelines, this will make the doc look cleaner.

Additional note

These are just 2 doc changes which I thought to mention, to get the discussion started on this issue. There might be more changes which could be included in this issue so I will look for a more changes in the readme doc and will update in this issue.

Just one question, what do the maintainers think about this ?

Thanks!