Create a libp2p.io/specs website

オープン
#155 コメント 2 件 リアクション 1 件 担当者 2 名 GitHub で見る

@salmad3 がすでに取り組んでいます。

2022年12月22日 から。

評価

この issue はまだ評価されていません。

説明

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.adoc

and 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

主要言語
Less
スター
41
フォーク
34
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

libp2p/website のほかの issue

libp2p/website の issue をすべて見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。