docs: developer-first README; relocate SDK-audit commands to docs/research.md#49
Merged
Merged
Conversation
…s/research.md The README opened with a maintainer-facing "Upstream SDK / spec discovery" block (npm/pip artifact-fetch commands for auditing OTHER SDKs) before the value prop, features, or quick start — poor first-time onboarding. Restructure for "easy to read, install, set up, keep up to date, and use": - Relocate the artifact-discovery commands out of the README into docs/research.md (new "Reproducing the artifact audit" subsection after "SDK Versions Analyzed"); refresh the commands to current parity targets (kalshi-typescript, kalshi-python-sync/async 3.16.0). - Reorder to a developer-first flow: hero (title + badges + what/why) → Features → Quick start (FetchContent pinned to v0.4.8 + a minimal ~10-line first call) → Versioning → Usage → Architecture → Building from source → API Coverage → Documentation → Contributing → License → References. - Add "Versioning & staying up to date": SemVer + pre-1.0 caveat, CHANGELOG, release-discovery flow, how to bump the pinned GIT_TAG, and the kalshi::VERSION single-source-of-truth guard. - Add exact prerequisite install lines (apt-get / brew) for openssl/libcurl/libwebsockets; document KALSHI_BUILD_TESTS/EXAMPLES options. Bug fixes: clone URL your-org → Reddimus (FetchContent + git clone); stale "155 tests" → "160+ tests" (actual 163, drift-resistant); resolve the "(Coming soon)" API-reference stub → docs/README.md; correct the CI note (macOS/Windows run build+test, lint is Linux-only). All substantive content preserved (full 75-method API coverage, REST + WS examples, both mermaid diagrams, build tables). markdownlint-cli2: 0 errors. Authored via a 7-agent analysis→synthesis→adversarial-verification workflow.
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
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.
Why
The README opened with a maintainer-facing "Upstream SDK / spec discovery" block (npm/pip commands for auditing other SDKs) — sitting between the title and the value prop, before Features or Quick Start. That's the first thing a new C++ developer saw. This restructures the README to be easy to read, install, set up, keep up to date, and use, and moves the auditing commands to where they belong.
What changed
Relocation (the core ask):
docs/research.md→ new "Reproducing the artifact audit" subsection right after "SDK Versions Analyzed" (it's a contributor/parity concern, and research.md already holds the SDK comparison + parity matrix). Commands refreshed to current parity targets (kalshi-typescript, kalshi-python-sync/async 3.16.0); dropped the stalekalshi@0.0.5/kalshi-python==2.1.4pins.Developer-first reorder:
v0.4.8with tests/examples off → get API keys → minimal ~10-line first call) → Versioning & staying up to date → Usage → Architecture → Building from source / development → API Coverage → Documentation → Contributing → License → References.GIT_TAG, and thekalshi::VERSIONsingle-source-of-truth guard.KALSHI_BUILD_TESTS/KALSHI_BUILD_EXAMPLES.Bug fixes found along the way:
your-org→Reddimus(both the FetchContentGIT_REPOSITORYand thegit clone).docs/README.md.Preserved + verified
include/kalshi/(compiles).Authored via a 7-agent analysis → synthesis → adversarial-verification workflow; the verify pass caught the CI-description inaccuracy and confirmed the examples compile. Docs-only — no code touched.