docs(readme): add Evidence Export + Policy Simulation rows to Eval table#144
Merged
Conversation
Brings SDK README Eval Tier table to 7 rows, matching the 4 plugin READMEs and the 'consistent level of detail' standard. Audience-tuned rows differ between SDK (Concurrent executions, Pending execution approvals — MAP/WCP-relevant for SDK readers building MAP workflows) and plugin (HITL approval gates, session overrides — plugin-relevant for governance hooks), but the row count is now equal across both README families. Numbers verified against the runtime tier config.
…m capabilities Reviewer feedback on PR: in a language-SDK README the rows for Evidence Export and Policy Simulation could read as if they're SDK methods (e.g., client.exportEvidence(), client.simulatePolicy()). They are not — both are licensed platform capabilities accessed via the AxonFlow API or the customer portal, not via language-specific SDK helpers. Added a Note callout below the existing footnote line that says exactly that. Rows stay (they are real Evaluation-tier upgrade triggers worth surfacing), the framing is now honest about how they're consumed.
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.
Summary
Brings the SDK README Eval Tier table from 5 rows to 7 rows, matching the four plugin READMEs.
Why: review feedback flagged that SDK READMEs showed a more compact 5-row table while plugin READMEs showed 7 rows. Audience-tuned rows are fine, but the level of detail should match across both README families.
Rows added:
Evidence export (CSV / JSON) — | 5,000 records · 14d window · 3/day | UnlimitedPolicy simulation — | 300 / day | UnlimitedWhy these specific rows for SDKs: both are tier-gated runtime features verified directly against
platform/agent/license/tier_support.go(MaxEvidenceExportRecords,MaxEvidenceWindowDays,MaxEvidenceExportsPerDay,MaxSimulationsPerDay), and both are meaningful to SDK users moving from Community to Eval (audit/compliance teams care about Evidence Export; SDK developers testing rules care about Policy Simulation).Plugin READMEs unchanged — already at 7 audience-tuned rows. Different rows (HITL approval gates, session overrides) for that audience.
Test plan