docs: expand and reorganize mdBook docs (transports, server features, releases, quickstart)#131
Merged
Merged
Conversation
MisterVVP
added
the
codex
ChatGPT Codex Connector
… releases, quickstart) ### Motivation - Expand the mdBook documentation from a bootstrap skeleton into a usable developer guide covering client/server APIs, transports, streaming, auth, and operational guidance. - Add missing conceptual pages (releases/versioning, transports overview, interceptors, push-notifications) and improve quickstart and installation guidance for contributors and consumers. - Align README/SUMMARY navigation and examples with the documented SDK surface so readers can find API and example usage easily. ### Description - Rewrote and expanded `book/src/README.md`, `SUMMARY.md`, and many client/server/transports/streaming/auth pages to provide concrete API lists, recommended flows, and operational guidance. - Added new pages: `book/src/releases.md`, `book/src/server/interceptors.md`, `book/src/server/push-notifications.md`, and `book/src/transports/overview.md` to document releases, server interceptor patterns, push-notification APIs, and transport selection guidance. - Improved developer workflows and examples in `getting-started/installation.md` and `getting-started/quickstart.md`, added clearer CMake usage, build/test commands, and install instructions, and updated API reference generation notes in `api-reference.md`. - Updated docs and parity/readiness files under `docs/` to reflect current packaging focus (vcpkg) and to tighten the SDK readiness/parity narratives. ### Testing - Built the docs site with `mdbook build book` to validate the generated book and navigation, and the build completed successfully. - No source code changes were made, so unit/integration test suites were unaffected by this documentation-only update.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
book/src/README.md,SUMMARY.md, and many client/server/transports/streaming/auth pages to provide concrete API lists, recommended flows, and operational guidance.book/src/releases.md,book/src/server/interceptors.md,book/src/server/push-notifications.md, andbook/src/transports/overview.mdto document releases, server interceptor patterns, push-notification APIs, and transport selection guidance.getting-started/installation.mdandgetting-started/quickstart.md, added clearer CMake usage, build/test commands, and install instructions, and updated API reference generation notes inapi-reference.md.docs/to reflect current packaging focus (vcpkg) and to tighten the SDK readiness/parity narratives.