Cloud-CV / Cloud-CV/Origami

[Docs] Refinement of Readme.md

Open
#301 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
172
Forks
109
PR merge metrics
No merged PRs in 30d

Description

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
1. 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.

Screenshot 2019-11-23 at 2 25 07 AM

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.

2. 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.
Screenshot 2019-11-23 at 2 55 19 AM

## 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!

Contributor guide

Open the contributing guide

Research direction

Start by reviewing README.md, especially the Installing Docker and Windows installation sections, and check the existing documentation structure. Identify the current installation references and any related documentation files mentioned there. Done means the Docker steps are consistently structured and referenced, while Windows installation guidance is moved or linked as proposed.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.