docs: refresh README, ROADMAP, and ARCHITECTURE for shipped features - #140
Merged
Conversation
The top-level docs had drifted behind the runtime. Bring them current: README: - SDK install is no longer 'from source' — pip install riskkernel (PyPI) and npm install @riskkernel/sdk (npm); list all the framework adapters (Claude Agent SDK, OpenAI Agents, LangChain, LlamaIndex, CrewAI, AutoGen, PydanticAI + Vercel). - The capability grid now reflects what shipped: approvals via Slack too, policy-as-code, spend attribution + compliance export, optional Postgres, and OTel both ways (export AND ingress). - The proxy note mentions streaming and the Anthropic endpoint and native providers; the audit command list adds 'audit summary' and 'audit compliance'. ROADMAP: - Move everything that shipped out of 'Next' into 'Shipped' — streaming, OTLP ingress, Postgres, the four new adapters, Ollama, /metrics, doctor, completions, per-run policy enforcement, spend attribution. 'Next' is now just Bedrock, a Datadog dashboard, and the Homebrew tap. ARCHITECTURE: - otel does export + ingress; Postgres is a shipped opt-in backend, not 'future'.
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.
The top-level docs had drifted behind the runtime — a lot shipped (streaming on both endpoints, OTLP ingress, Postgres, four new framework adapters,
audit summary, the SDKs going to PyPI/npm) that the README/ROADMAP/ARCHITECTURE didn't reflect. This brings them current. Docs-only; no code change.README
pip install riskkernel(PyPI) andnpm install @riskkernel/sdk(npm); the adapter list now includes Claude Agent SDK, OpenAI Agents, LangChain, LlamaIndex, CrewAI, AutoGen, PydanticAI (Python) + Vercel AI SDK (TS).audit summaryandaudit compliance.ROADMAP
/metrics,doctor, completions, per-run policy enforcement, spend attribution. "Next" is now just AWS Bedrock, a Datadog dashboard, and the Homebrew tap.ARCHITECTURE
otelpackage does export + ingress; Postgres is a shipped opt-in backend, not "a future opt-in".The per-feature docs (BUDGETS, RESUME, POLICY, METRICS, OTLP_INGRESS, POSTGRES, COMPLIANCE, TROUBLESHOOTING, APPROVALS_SLACK, PERFORMANCE) were each shipped with their feature and are already current; VISION + COMPATIBILITY were updated at the v0.7.0 release.
Verified: all referenced doc links resolve to real files; tables well-formed.