Create a libp2p.io/specs website

Aperta
  • Qualcosa non va?
#155 2 commenti 1 reazione 2 assegnatari Vedi su GitHub

@salmad3 ci sta già lavorando.

Dal 22/12/2022.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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

Lingua principale
Less
Stelle
41
Fork
34
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di libp2p/website

Tutte le issue di libp2p/website

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.