Write the README for xmtp-dot-org/Docs contribution guidelines - Githubissues

xmtp / xmtp-dot-org

xmtp.org, powered by Docusaurus

https://xmtp.org

MIT License

11 stars 25 forks source link

Write the README for xmtp-dot-org/Docs contribution guidelines #46

Closed jhaaaa closed 2 years ago

jhaaaa commented 2 years ago

Who is the user persona for this readme?
- People who want to contribute to Dev Portal docs. These users may want to:
  - Understand how to submit edits to content on the Dev Portal
  - Understand what happens to their PRs
  - Understand style guidance?
  - Understand how to build the portal locally to see the impact of their changes before pushing
- People who stumble upon the repo as they explore the XMTP org. These users may want to:
  - Explore the repo and see what's available. For example, we might want to point them to xmtp.org or know where to find the doc files in the repo.

jhaaaa commented 2 years ago

Good v1 starter content: https://docs.xmtp.org/contributing/

Probably want to get more specific and provide more detailed guidelines for code and for docs.

Examples for code contribution guidelines: https://ethereum.org/en/contributing/, https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md, https://xrpl.org/contribute-code.html
Example for doc contribution guidelines: https://github.com/XRPLF/xrpl-dev-portal/blob/master/CONTRIBUTING.md

jhaaaa commented 2 years ago

Related to https://github.com/xmtp/xmtp-dot-org/issues/65

jhaaaa commented 2 years ago

Completed via https://github.com/xmtp/xmtp-dot-org/pull/101