Meshery: Docs: docs/README.md update needed

Created on 27 Oct 2019  路  5Comments  路  Source: layer5io/meshery

Description
The /docs/README.md is outdated and needs to be update to reflect the Meshery project.

Expected Behavior
The README.md should have:

  • [ ] a screenshot relevant to Meshery.
  • [ ] a link to and description the Meshery documentation contribution instructions.
  • [ ] an example of how to build the docs locally (and a link to Jekyll for reference).

- [ ] a link to the Meshery Documentation Google Doc.

Contributor Resources

aredocs hacktoberfest help wanted

Most helpful comment

@schillingjerrid I would use a screenshot of the docs site since it's the docs readme. It can always be changed!

All 5 comments

I'll grab this one!

@leecalcote Would you like to see a screenshot of the docs for Meshery or of the Meshery dashboard itself?

@schillingjerrid I would use a screenshot of the docs site since it's the docs readme. It can always be changed!

@schillingjerrid thanks much for taking this issue on ( 馃憤 ) and for being considerate of the screenshot to include.

I concur with @firstladymb's suggestion that given that this README is documentation-specific, a screenshot of the docs site is most appropriate.

PR has been merged into master. Closing this issue.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Aisuko picture Aisuko  路  3Comments

leecalcote picture leecalcote  路  4Comments

Aisuko picture Aisuko  路  4Comments

sakomws picture sakomws  路  4Comments

leecalcote picture leecalcote  路  4Comments