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

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

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
42/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
c, markdown
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
C
スター
0
フォーク
0
平均マージ
20時間 4分
マージ済み PR(30日)
25

環境構築

はじめの一歩

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

public/cursed-http のほかの issue

public/cursed-http の issue をすべて見る

似ている issue

C の issue をもっと見る

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

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