Add "how to create a page" contributor guide

libp2p / docs

Documentation site for the libp2p project.

https://docs.libp2p.io/

Other

60 stars 87 forks source link

Add "how to create a page" contributor guide #252

Open salmad3 opened 1 year ago

salmad3 commented 1 year ago

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 commented 1 year ago

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

TMoMoreau commented 1 year ago

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.

salmad3 commented 1 year ago

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