docs: reconcile spec with the shipped implementation (impl→spec)#124
Merged
Conversation
Phase B of the conformance pass — update docs the Phase-A PRs made stale (audit finding #7 + sweep). - dx.md: escurel-client + escurel-test-support are delivered, not "not yet implemented"; status flipped to Delivered. - operations.md: /metrics is on the dedicated :9090 listener and now lists the per-tool families; the log section documents the tool.completed audit record (tenant/tool/transport/subject/ duration_ms). - platform.md: reconcile metric naming (dotted logical ↔ underscore Prometheus wire names) and flag which families are live vs reserved (write_lock_wait_ms / embed_* / storage_bytes not yet populated). - agent-interface.md: note the prototype-gap table rows (neighbours, validate, write path, run_stored_query, meta-skill, page granularity) now all ship. Docs-only; no code change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
Phase B of the spec↔impl conformance pass: update the docs that the
Phase-A PRs (#116, #118–#123) made stale (audit finding #7 plus a
sweep). Docs-only — no code change.
dx.md—escurel-client+escurel-test-supportaredelivered, not "not yet implemented"; status flipped to Delivered
with pointers to the crates and their tests.
operations.md—/metricsnow correctly documented on thededicated
:9090listener (not the main port) and lists the per-toolfamilies; the log section documents the
tool.completedper-callaudit record.
platform.md— reconcile metric naming (the dotted logical namesescurel.tool_callsrender asescurel_tool_callson the Prometheuswire) and flag which families are live vs reserved
(
write_lock_wait_ms,embed_*,storage_bytesare specified butnot yet populated — matching the deferral noted in feat(obs): per-tool metric set (tool_calls, latency, sessions, drift) #121).
agent-interface.md— note that the prototype-gap table rows(neighbours, validate, write path, run_stored_query, the meta-skill,
page granularity) now all ship.
Test plan
Docs-only; verified the diff touches only
docs/**and thatreferenced paths (
examples/echo-app, the crate test files) exist.🤖 Generated with Claude Code