Skip to content

docs: complete v0.9 user-facing examples and guide - #29

Merged
zuudevs merged 2 commits into
mainfrom
docs/v0.9-user-guide
Sep 15, 2026
Merged

zuudevs merged 2 commits into
mainfrom
docs/v0.9-user-guide

Conversation

@zuudevs

@zuudevs zuudevs commented Sep 15, 2026 •

Copy link
Copy Markdown
Owner

Summary

Completes v0.9 with the remaining user-facing examples/documentation and synchronizes the roadmap before entering the v1.0 release gate.

README

  • explains project purpose and frozen v1 scope
  • documents C++17 / CMake 3.21+ requirements
  • documents supported platforms and methods
  • calls out HTTP-only / no HTTPS-TLS in v1
  • shows quick-start GET usage
  • shows install-tree CMake consumption through cpp_request::cpp_request
  • documents reusable Client, response limits, thread-safety, and explicit non-goals
  • links API, lifetime, error, response-limit, roadmap, and CMake docs

Getting started guide

Documents:

  • one-shot helpers
  • persistent Client reuse
  • POST bodies
  • custom headers and query parameters
  • borrowed URL/body lifetime rules
  • connect/read/write timeouts
  • redirect behavior
  • response limits
  • structured error handling
  • thread-safety expectations
  • install-tree consumption

Executable examples

Adds local-only examples for:

  • simple GET + error handling
  • POST with custom headers, query parameters, and borrowed body
  • configured reusable Client with timeouts, redirects, and response limits

All examples target 127.0.0.1:8080; they compile in normal CI but are not network-dependent automated tests.

Roadmap synchronization

Scope

This PR does not change HTTP behavior or public C++ API semantics. It documents and demonstrates the already-frozen v1 surface.

@zuudevs
zuudevs merged commit fcccb76 into main Sep 15, 2026
6 checks passed
@zuudevs
zuudevs deleted the docs/v0.9-user-guide branch September 15, 2026 02:46
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.

1 participant