Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Additional README.md files #148

Closed
minkyraccoon opened this issue Jul 13, 2021 · 0 comments
Closed

Additional README.md files #148

minkyraccoon opened this issue Jul 13, 2021 · 0 comments
Assignees
@minkyraccoon @PaddyMc
Labels
documentation Improvements or additions to documentation

Comments

@minkyraccoon
Copy link
Contributor

Context

ADR-002 recommended a Comos Cash documentation strategy. This issue is part of an epic to implement that strategy.

Well written READMEs will help coordinate readers within the repo and the code. It will also indicate how the documentation works and where to find information.

Objective

By the end of this issue, there will be the following READMEs

  • /docs/README.md\
  • /docs/Explanation/README.md
  • /docs/Reference/README.md
  • /docs/Tutorials/README.md
  • /docs/How-To/README.md

These README's will highlight the purpose of each part of the documentation following the Divio guidelines.

The main README will be changed such that

  • Introduction
  • It will point users to the documentation points
  • How to Contribute
  • How to get set-up
  • Other documentation
@minkyraccoon minkyraccoon added the documentation Improvements or additions to documentation label Jul 13, 2021
@minkyraccoon minkyraccoon self-assigned this Jul 13, 2021
minkyraccoon pushed a commit that referenced this issue Jul 27, 2021
feat(docs): Add explanation structure (#148)
b6c8383
minkyraccoon pushed a commit that referenced this issue Jul 29, 2021
feat(docs): READMEs for Explanation and Reference documentation. (#148)
156541f
minkyraccoon added a commit that referenced this issue Aug 18, 2021
@minkyraccoon
feat(docs): READMEs for docs, Explanation and Reference Documentation (…
184808c 
…#148) (#168)

* feat(docs): Add explanation structure (#148)

* feat(docs): READMEs for Explanation and Reference documentation. (#148)

* feat(docs): apply proposals from technical editor review (#168)

Co-authored-by: Barrie Byron <[email protected]>

* docs: Changes based on Technical Writer Review

* fix: README introductions based on feedback

* fix: Apply suggestions from code review

Co-authored-by: Barrie Byron <[email protected]>

Co-authored-by: Barrie Byron <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@minkyraccoon minkyraccoon

@PaddyMc PaddyMc

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@minkyraccoon @PaddyMc