← 输入框|github.com|刷新
Skip to content

Add the Documentation of the website and contributing guide to Read the Docs #102

Closed

Description

@tapaswenipathak

Currently the documentation of the website is explained in README.

It will be good to have the information about

  1. branches
  2. hound, travis enablement
  3. installation instruction
  4. issue and labels

available on Read the Docs.

Activity

  1. vaibhavsingh97 commented on Sep 12, 2017

    @vaibhavsingh97
    Member

    @tapasweni-pathak Google open sourced Google Developer documentation style guide. We can use it to bootstrap our own style guide. Read more about here https://opensource.googleblog.com/2017/09/making-google-developers-documentation.html?m=1
    We can use this for documentation.
    Cc: @nikhita @anubhakushwaha @sandarumk
    What are your opinion?

  2. tapaswenipathak commented on Sep 17, 2017

    @tapaswenipathak
    MemberAuthor

    @vaibhavsingh97 We can compare these two before going ahead with one. ReadTheDocs is quite established project made to fulfill the needs of documentation required and used widely by many projects. It has search and components it used underneath are also open source. Not sure about Google Developer documentation style guide, would like to know.

    Also can you please explain a bit more about we can bootstrap our own style guide, I didn't quite clearly get this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions