Restructure README#34
Merged
Merged
Conversation
README: - Remove "Works with Claude Code" from The Problem section - Remove "Why not LangSmith / Langfuse / Datadog" section - Remove inline Architecture mermaid diagram (moved to docs/) - Replace inline Claude Code, NemoClaw, OpenClaw, and framework details with hyperlinks to dedicated docs - Slim framework support to a summary table linking to docs/ New docs: - docs/claude-code-integration.md — full Claude Code setup, MCP, uninstall - docs/nemoclaw-integration.md — NemoClaw sandbox event observability - docs/framework-support.md — provider patches, framework patches, OTLP, TS SDK Updated docs: - docs/architecture.md — replace ASCII diagram with mermaid flowchart from README Also: - pyproject.toml: 0.1.7 → 0.1.8 - sdk-ts/package.json: 0.1.7 → 0.1.8 - CLAUDE.md: add critical rule #14 (version bump on release) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The Contributing tab (CONTRIBUTING.md) already covers setup, tests, PR guidelines, and Claude Code workflow. Added [mcp] extra to the install command there. Removed the redundant section from README. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…docs New docs: - docs/alerts.md — 13 alert types, 6 channels, cooldown, content stripping - docs/export.md — JSON/CSV/OTLP/OpenEvals formats, Prometheus, REST API - docs/configuration.md — full TOML reference with all sections explained - docs/cli-reference.md — all 15 commands with flags and examples README sections replaced with one-line summaries + hyperlinks. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New docs: - docs/examples.md — full example list with env vars, deps, and setup notes - docs/roadmap.md — completed and planned features Updated: - README: replace Framework Support table, Examples list, and Roadmap checklist with one-line summaries + hyperlinks Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Fix /v1/logs: not a stub, it's the Claude Code log-to-span converter
- Fix Web UI: six views not five (Budget was missing)
- Add auto-polling intervals (Status 5s, all others 10s)
- Fix onboard --claude-code: writes to ~/.config/ocw/config.toml (global),
not .ocw/config.toml
- Add MCP registration and daemon --config flag to onboard flow
- Add full REST API route inventory table (includes /agents, /budget,
/alerts/{id}/acknowledge that were undocumented)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
cli-reference.md: - Add missing --budget and --force flags to ocw onboard - Fix ocw cost: flag is --group-by, not --by - Add missing --unread flag to ocw alerts - Add --host, --port, --reload flags to ocw serve alerts.md: - Add missing session_duration alert type (13th of 13) configuration.md: - Fix export.otlp.protocol default from "http/protobuf" to "http" Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add Claude Code → POST /v1/logs as the third ingest path with log-to-span conversion label. Add Web UI and MCP Server as DB consumers (were missing). Update description to match. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
anilmurty
changed the title
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.
Summary
Restructure the README by moving detailed sections into dedicated docs under
docs/and verify all docs against the current codebase.README changes
docs/architecture.md)New docs
docs/claude-code-integration.md— full setup, MCP server, multi-project, uninstalldocs/nemoclaw-integration.md— sandbox event observability, alert types, configdocs/framework-support.md— provider patches, framework patches, zero-code OTLP, TypeScript SDKdocs/alerts.md— 13 alert types, 6 channels, cooldown, content strippingdocs/export.md— JSON/CSV/OTLP/OpenEvals formats, Prometheus, REST APIdocs/configuration.md— full TOML reference with all sectionsdocs/cli-reference.md— all 15 commands with flags and examplesdocs/examples.md— full example list with env vars and setupdocs/roadmap.md— completed and planned featuresDocs verified and fixed against codebase
docs/architecture.md— fixed /v1/logs (not a stub), added Budget as 6th web UI view, added auto-polling, fixed --claude-code config path, added MCP registration to onboard flow, added full REST API route inventory, updated diagram to show all 3 ingest paths + MCP/Web UI consumersdocs/cli-reference.md— fixed --group-by (was --by), added missing flags (--budget, --force, --unread, --host, --port, --reload)docs/alerts.md— added missing session_duration alert typedocs/configuration.md— fixed export.otlp.protocol defaultCONTRIBUTING.md— added [mcp] extra to install commandOther
pyproject.toml+sdk-ts/package.json— 0.1.7 → 0.1.8CLAUDE.md— added rule Fix SDK DuckDB lock, LiteLLM model prefix, sidebar SVG logo #14 (version bump on release)Test plan
docs/architecture.mdpytest tests/unit/ tests/synthetic/ tests/agents/ tests/integration/🤖 Generated with Claude Code