Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Make a guide to contributing to this docs repo #79

Closed
Mr0grog opened this issue Jul 10, 2018 · 1 comment
Closed

Make a guide to contributing to this docs repo #79

Mr0grog opened this issue Jul 10, 2018 · 1 comment
Assignees

Comments

@Mr0grog
Copy link
Collaborator

Mr0grog commented Jul 10, 2018

Explain Hugo, how to build, how some docs come from other repos, so pull requests should be there instead of here, etc.

@Mr0grog
Copy link
Collaborator Author

Mr0grog commented Jul 25, 2018

Should also talk about what various types of docs should be/should cover. I’ve added this to a few issues about concept docs, but it should really be in this guide:

Concept docs are concise, high-level descriptions of various core concepts in IPFS. They live in the content/guides/concepts folder and should strive to answer:

  1. What is this?
  2. How does it relate to the rest of IPFS?
  3. How can (or should?) you use it? (Note: sometimes the answer is that you should understand it, but not use it. Bitswap is probably a good example.)
  4. Where do you go to learn more?
  5. What is the current state of affairs?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant