docs: README, H2H3.md and an API reference for what 0.1 ships

Aperta
#59 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
c, markdown
Ambito
documentation

Direzione di ricerca

Start with README.md, where the 'server side only' status claim sits, and H2H3.md's 'Limits and simplifications' section, then compare both with the client functions h2_init_client, h3_init_client, quic_connect and quic_connect_resume in their headers. Done when every public function and struct field in those headers, plus fbresp.h, has documentation and the README status section matches the 0.1 release.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation P0: release blocker

After the merges in the 0.1 milestone the docs no longer match the code:

  • README.md says the HTTP/2, HTTP/3 and QUIC engines are "server side only".
  • H2H3.md's "Limits and simplifications" still lists no 0-RTT, 0 QPACK blocked streams, no Retry or Version Negotiation on the client, and only curl and aioquic as real clients.
  • The client APIs (h2_init_client, h3_init_client, quic_connect, quic_connect_resume), the raw-QUIC interface from #50 (ALPN lists, server-opened streams, per-connection limits) and fbresp.h are documented only in header comments.

Needed:

  1. README and H2H3.md rewritten for what 0.1 actually ships, client and server, with the remaining limits stated plainly.
  2. An API reference per header: lifecycle, callbacks, ownership and buffer rules, error codes, and thread-safety (none: one connection, one thread).
  3. A short guide for each example: an HTTP/3 server, an HTTP/2 client, raw QUIC (examples/quic_echo.c).

Done when: every public function and struct field is documented, and the README's status section matches the release.

Lingua principale
C
Stelle
0
Fork
0
Merge medio
20h 4m
PR unite (30g)
25

Preparare l'ambiente

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 public/cursed-http

Tutte le issue di public/cursed-http

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.