Skip to content

docs: shorten the repository overview - #51

Merged
P4suta merged 1 commit into
mainfrom
docs/http3-readme
Oct 23, 2026
Merged

P4suta merged 1 commit into
mainfrom
docs/http3-readme

Conversation

@P4suta

@P4suta P4suta commented Oct 23, 2026

Copy link
Copy Markdown
Owner

@coderabbitai ignore

Change proposal

Change

Keep the README focused on the unpublished packages, source setup, and one check command.
Move the existing client and server examples and release qualification notes to docs/README.md with repaired links.
Add repository metadata and canonical copies of the existing MIT OR Apache-2.0 license.
The original LICENSE and LICENSES files and contributor attribution stay unchanged.
The GitHub description matches the summary.

Evidence

  • This is documentation and metadata only.
  • Local generation and remote description checks pass.
  • Markdown lint, TOML format, and diff checks pass.
  • Existing documented examples stay within the recursive example scanner's scope.
  • mise run check hasn't run locally for this documentation change.
  • Fault, property, fuzz, interop, coverage, and performance campaigns haven't run locally.

Security and release scope

No runtime code, public API, credentials, package versions, or release workflows change.
The packages remain unpublished.

Closes #50.

@P4suta
P4suta marked this pull request as ready for review October 23, 2026 16:59
@P4suta
P4suta merged commit d4edf4f into main Oct 23, 2026
13 of 15 checks passed
@P4suta
P4suta deleted the docs/http3-readme branch October 23, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: shorten generated http README

1 participant