docs icon indicating copy to clipboard operation
docs copied to clipboard

Add "how to create a page" contributor guide

Open salmad3 opened this issue 2 years ago • 3 comments

Add the ipfs-docs contributor guide being worked on when ready.

Done Criteria

  • [ ] Adapt https://github.com/ipfs/ipfs-docs/pull/1294 and libp2p-ize it.

Why Important

  • Great resources for contributors especially first-time contributors.
  • Encourages contributions

salmad3 avatar Nov 23 '22 06:11 salmad3

@TMoMoreau do you want to take this on and revise the existing doc to match the libp2p docs site/repo?

salmad3 avatar Jan 23 '23 21:01 salmad3

Absolutely, should be fairly straight forward. Do you have any ideas where this would live already? As in, does the libp2p docs repo have a similar CONTRIBUTING.md file already, or should this live in the actual docs somewhere?

Edit: Took a quick look, looks like there is no existing page or file that this could be implemented into. If it works for you, I can add a page to this repo (CONTRIBUTING.md) and put the guide in there, which is exactly what the ipfs-docs repo has.

TMoMoreau avatar Jan 23 '23 21:01 TMoMoreau

We have a Contributor section that this could go under: https://docs.libp2p.io/concepts/contribute/community/

salmad3 avatar Jan 24 '23 13:01 salmad3