Refresh May documentation bundle - #23
Merged
Merged
Conversation
Synced public-safe source docs from private commit 96385c7 and staging commit 00154af, then updated CustomerNewsletter public MkDocs navigation. Source docs and public-only docs were reviewed in targeted local-review batches. Validation passed: make test-all, newsletter validators, sensitive scan, link check, and mkdocs.yml parse.
Updates PR #23 with companion-led landing, standalone START_HERE copy, source-owned public bundle resources, FinOps playbook, and worked examples. The shipped May newsletter output and Discussion links were not changed. Source/staging commits: 33996bc / 0d7efc3. Targeted local reviews and validation passed.
- Merge admin/FinOps and developer/worked-example files - Repurpose system release notes into technical deep dive with exact before/after token counts, code links, and illustrative cost - Slim START_HERE to a pointer; add BLUF blocks to all 9 retained files - Retire 6 redundant files
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
Refreshes, expands, and then consolidates the May 2026 public cost-optimization bundle without changing the shipped newsletter text, shipped newsletter links, or Discussion #21.
Phase 1 expanded the bundle and made
CUSTOMER_COMPANION.mdthe canonical landing page. Phase 2 (this update) cuts redundancy from 13 public files to 9, adds real technical depth (exact before/after token counts, links to the actual workflow code, and an illustrative dollar translation), and standardizes a Bottom Line Up Front (BLUF) block on every retained file.Commits
Public file set (13 to 9)
Retained, each with a standard BLUF block:
README.md-- bundle map and read path, rewritten to the 9-file setSTART_HERE.md-- slimmed to a thin pointer back to the companionCUSTOMER_COMPANION.md-- canonical shipped-newsletter landing page with role routingADMIN_FINOPS_GUIDE.md-- NEW; merges admin readiness + FinOps (budgets, reporting, governance, attribution, showback)DEVELOPER_GUIDE.md-- NEW; merges developer workflow + worked examplesNEWSLETTER_SYSTEM_RELEASE_NOTES.md-- repurposed into a technical deep dive with exact before/after token counts, code links, request/tool-call deltas, and an illustrative API-equivalent cost translationPRODUCT_FEATURE_QUICK_HITS.md-- first-party feature inventoryNEWSLETTER_MAY_COST_SECTION.md-- verbatim newsletter excerpt (provenance)PUBLIC_SOURCES.md-- consolidated public source listRetired (merged into the files above; removed from the allowlist and added to the prune list so the target copies are deleted):
EXECUTIVE_SUMMARY.md,ADMIN_READINESS_GUIDE.md,FINOPS_PLAYBOOK.md,DEVELOPER_WORKFLOW_GUIDE.md,WORKED_EXAMPLES.md,PRODUCT_FEATURES_FOR_COST_MANAGEMENT.md.Technical depth added
The deep dive now reports exact before/after aggregate token totals (fixed-corpus ~7,846,260 to ~5,699,291, roughly -27%; current-cycle ~9,001,070 to ~4,957,442, roughly -45%), request and tool-call deltas, and an illustrative ~$3 per million blended API-equivalent translation derived from the system's own output-shape matched-pair data and citing the public OpenAI pricing page. Dollar figures are framed as illustrative API-equivalent estimates on direct provider tokens, not a GitHub Copilot bill, and one model is named only as an illustrative example.
Shipped-content invariant
No edits were made to
output/2026-05_may_newsletter.md, Discussion #21, or the shipped newsletter's link target. All bundle resources are reached throughCUSTOMER_COMPANION.mdand the in-bundle links.Public/private boundary
The public bundle keeps illustrative/estimate framing and explicit non-billing caveats. It does not publish private run logs, exact private token tables, private evidence paths, source-note directories, planning/runs/workspace internals, or billing-savings claims.
Validation
make test-allpassed all required suites including the Control-Surface Drift Guardmake test-allpassed required suites with expected private-fixture/config skipsmake test-allpassed required suites with expected skipsgit diff --check: clean