Create a libp2p.io/specs website
@salmad3 is already working on this.
Since Dec 22, 2022.
- Dominant language
- Less
- Stars
- 41
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
The specs repo should be served separately similar to spec.filecoin.io
The rendered output is a nicer way to read the specifications. It matters more for casual users/new learners who are not writing/updating specs on a day to day basis.
There are existing solutions to deploy a site directly from the specs directory without needing to duplicate content or incurring maintenance overhead (aim should be zero overhead) for specs writers/maintainers.
My favorite examples are this spec site: https://internetcomputer.org/docs/current/references/ic-interface-spec/
rendered from this AsciiDoc: https://github.com/dfinity/interface-spec/blob/master/spec/index.adocand the Filecoin spec site https://spec.filecoin.io/
copied from: https://github.com/libp2p/docs/discussions/210#discussioncomment-3930443
@DannyS03 's notion page: https://www.notion.so/pl-strflt/libp2p-specs-site-dfec46f10d5340dc87bbf0355159f0a5
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.