W-23547085 docs: review doc drift for exp-governance- topics (strategies + cost management) - #510
Open
luanamulesoft wants to merge 23 commits into
Open
W-23547085 docs: review doc drift for exp-governance- topics (strategies + cost management)#510luanamulesoft wants to merge 23 commits into
luanamulesoft wants to merge 23 commits into
Conversation
- cost-token-usage: restructure around budgets/optimizations tabs, fix metric labels (Cost saved, Potential savings), correct time range options (remove 6H), fix filter description - create-strategy: fix button/step labels to sentence case, rename step to General Information, add Notifications step note for Controls, add Save as draft note, fix type names to singular - manage-strategies: add Draft to status filter, add Change to Draft action for Controls, clarify Reorder condition for Automated Policies - work-with-strategies: add Gateways to governed service types Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <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.
Doc Drift Findings — exp-governance- topics
Drift detection across 4 topics using the budget-management branch + taylor-model-library-july prototype. All findings confirmed against source code. No doc text has been auto-edited — review each finding and apply changes manually.
exp-governance-view-cost-and-token-usage
[HIGH] UNDOCUMENTED
Finding: Page has two tabs — budgets and optimizations — entirely undocumented. Opens on budgets by default.
Suggested fix: Add a section describing the two tabs. The page opens on the budgets tab by default. The optimizations tab shows token cost analysis for MCP server instances.
[HIGH] UNDOCUMENTED
Finding: Budgets tab content is entirely undocumented: Total Managed Spend, By Provider, By Model Proxy Key.
Suggested fix: Add a Budgets tab section documenting: Total Managed Spend — total spend across all configured budgets; By Provider — spend breakdown by LLM provider; By Model Proxy Key — spend breakdown by model proxy client key.
[MEDIUM] LABEL_MISMATCH
Finding: The doc calls this metric "Saved Tokens (Est.)" but the UI label is "Cost saved" (subtitle: "Saved on optimized instances"). The label, framing (cost not tokens), and qualifier (Est.) all differ.
Suggested fix: Rename to: Cost saved: Tokens saved on optimized instances.
[MEDIUM] UNDOCUMENTED
Finding: The Optimizations tab includes a "Potential savings" metric (subtitle: "From unapplied opportunities") not mentioned in the doc.
Suggested fix: Add to the Optimizations tab section: Potential savings: Estimated tokens that could be saved by applying unapplied optimization opportunities.
[MEDIUM] INCORRECT
Finding: The doc lists "6 hours (6H)" as an available time range option, but the DateRangeSelector defines only four presets: 1H, 24H, 7D, and 30D. There is no 6H option.
Suggested fix: Remove "6 hours (6H)". Correct to: "Select a time range: 1H (1 hour), 24H (24 hours), 7D (7 days), or 30D (30 days). The default is 30D."
[MEDIUM] INCORRECT
Finding: The doc says filters refine by "service type, environment, or metadata", but the Optimizations tab filter panel contains only "Environment" and "Provider" sections.
Suggested fix: "Use Filters to refine the Optimizations view by Environment or Provider."
exp-governance-create-strategy
[HIGH] UNDOCUMENTED
Finding: Controls strategies have a "Save as draft" button on the final wizard step that is not mentioned in the doc. Automated Policies do not have this button.
Suggested fix: Add a note: "For Controls strategies, you can also select Save as draft to save the strategy without activating it."
[HIGH] UNDOCUMENTED
Finding: Controls strategies include a Notifications step (between "What to Apply" and "Name & Description") that is not mentioned in the doc. The doc's description applies only to Automated Policies.
Suggested fix: Note that Controls strategies include a Notifications step between the rules step and the Name & Description step. The Notifications step does not appear for Automated Policies strategies.
[MEDIUM] LABEL_MISMATCH
Finding: The doc capitalizes the button as "Create and Activate Strategy", but the UI renders "Create and activate strategy" (only the first word capitalized).
Suggested fix: Change to: Select Create and activate strategy.
[MEDIUM] LABEL_MISMATCH
Finding: The doc describes the last step as "activation" but the wizard's final step is labeled "Review". Activation happens via the submit button, not as a named step.
Suggested fix: Correct to describe the steps as: Strategy Type, Scope, What to Apply, Name & Description, and Review.
[LOW] LABEL_MISMATCH
Finding: The doc capitalizes the button as "Create Governance Strategy", but the UI renders "Create governance strategy".
Suggested fix: Change to: Select Create governance strategy to start the setup flow.
[LOW] LABEL_MISMATCH
Finding: The doc uses the plural forms "Controls" and "Automated Policies", but the wizard type-selection cards use the singular forms "Control" and "Automated Policy".
Suggested fix: Change to: Select the strategy type: Control or Automated Policy.
[LOW] LABEL_MISMATCH
Finding: The doc calls this step "Name and Describe the Strategy", but the wizard renders the step header as "General Information".
Suggested fix: Change to: General Information: Enter a unique name and optional description.
exp-governance-manage-strategies
[HIGH] INCORRECT
Finding: The doc lists only three status filter options but the UI has four: "Any Status", "Active", "Draft", and "Disabled". The "Draft" option is missing from the doc.
Suggested fix: "Use the status filter to select Any Status, Active, Draft, or Disabled."
[HIGH] UNDOCUMENTED
Finding: Controls strategies have a "Change to Draft" action in the row actions dropdown that is not mentioned in the doc. The doc lists only "Enable or disable" without mentioning draft state management.
Suggested fix: Add: "For Control strategies, you can also select Change to Draft to move the strategy back to a draft state without deleting it."
[MEDIUM] UNDOCUMENTED
Finding: A "Reorder" button appears on the Governance Strategies list view, but only when the type filter is set to Automated Policies. The doc mentions reordering as a generic action without noting this filter condition.
Suggested fix: "To change the order of Automated Policy strategies, set the type filter to Automated Policies and select Reorder."
exp-governance-work-with-strategies
[MEDIUM] INCORRECT
Finding: Gateways are a supported scope target (first-class radio option in the wizard scope step) not mentioned in the short description.
Suggested fix: "Use governance strategies to apply conformance rules and policies across agents, APIs, Gateways, and MCP servers."
GUS work item
W-23547085
Report files
20260722_budget-management_governance-cost-token-usage.json20260722_budget-management_governance-create-strategy.json20260722_budget-management_governance-manage-strategies.json20260722_budget-management_governance-work-with-strategies.json🤖 Generated by the doc-drift skill. All findings are suggestions — human review required before merging.