Repository navigation
Add ordered README flow and experimental-use warning - #39
Merged
Merged
Conversation
Generate the README walkthrough from coherent synthetic cycle and billing fixtures. Add ordering and layout checks, keep billing separate from delivery, and show one shared experimental-use warning on every tab. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 50509983-6ac1-467a-82f2-4aec8730c238
There was a problem hiding this comment.
🔵 Needs a closer look
Final human review is explicitly requested, and browser-based visual checks were not independently rerun here.
No open issues 🎉
What changed in this PR
Adds an ordered, synthetic work-to-billing illustration to the READMEs and a shared experimental-use warning across canvas tabs. Live billing and delivery behavior remain unchanged.
Changes:
- Generates seven chronological delivery steps and a separate mocked billing checkpoint from shared fixtures.
- Adds a persistent warning against relying solely on experimental results for billing, savings claims or performance decisions.
- Updates documentation, preview generation and checks for chronology, calculated estimates, layout and warning placement.
| File | Description |
|---|---|
tools/recipe-story.js |
Builds and renders the validated synthetic illustration. |
tools/README.md |
Documents illustration generation and preview checks. |
tools/make-canvas-shots.js |
Fixes fixture dates and adds illustration, chronology and footer checks. |
test/recipeStory.test.js |
Tests ordering, billing estimates, missing data and escaping. |
test/attributionCanvas.test.js |
Checks shared warning placement and wording. |
README.md |
Displays the ordered work-to-billing illustration. |
docs/media/recipe-flow.svg |
Adds the generated synthetic flow graphic. |
CONTRIBUTING.md |
Records footer and fixture-only ordering requirements. |
CHANGELOG.md |
Summarizes the warning and ordered example. |
.github/extensions/ai-attribution/ui/style.css |
Adds theme-aware warning styling. |
.github/extensions/ai-attribution/ui/index.html |
Places the warning outside the changing tab panel. |
.github/extensions/ai-attribution/README.md |
Explains the warning and embeds the illustration. |
Review effort: Balanced
Fix the VSIX rejection of repository SVG images on every CI platform. Keep the generated vector asset and guard both README embeds with a regression test. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 50509983-6ac1-467a-82f2-4aec8730c238
2 of 3 tasks
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.
What does this change?
Adds a coherent README-only work-to-billing illustration generated from the canvas's synthetic fixtures, with seven ordered delivery steps and a separate final mocked billing checkpoint. Adds one shared experimental-use warning to every tab and refreshes the documentation previews.
Why?
Follow-up to #38, based on its merged result. Makes the static examples chronologically consistent and clarifies that experimental results are not a sole basis for billing, savings claims or individual performance decisions.
The linear ordering checks apply only to educational fixtures, not real delivery histories. The illustration uses the calculated native-user/day/model estimate from the same mocked billing response; live billing/API behavior is unchanged.
Leave this PR open for manual review. Agent merge is disabled; do not merge or close it automatically.
How was it verified?
npm run typecheckpasses — passed.npm run packagesucceeds — passed.F5) and checked the behaviour by handnpm test— passed: 306 tests, zero failures.npm run check:docs— passed: 10 Markdown files.npm run media:canvas— passed: all synthetic previews; delivery-step, commit, review, merge and closure ordering; the calculated billing share; SVG layout/clipping checks; the shared footer on every tab; themes, keyboard navigation and narrow layouts.The updated canvas was loaded in the Copilot app. The VS Code
F5manual check was not run.src/chatWatcher.tsis unchanged. No real billing account or local work data was used to generate the assets.Screenshots
Synthetic repositories, accounts and API responses only. Billing follows delivery visually but is not an eighth delivery step or an invoice for an individual PR.