fix: align website copy with shipped contracts - #25
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Aligns the website’s documentation and marketing copy with the behavior and API surface of the shipped Askr packages, and adds regression tests to prevent drift.
Changes:
- Updated docs snippets to match current contracts (e.g.,
jsonSchema,RouteQuery.get(), keyed<For>, updated component props/variants). - Replaced “release notes” with explicit “upgrade guidance” on the docs landing page (including TOC/anchors and tests).
- Refreshed audited marketing language to avoid claims that exceed shipped package boundaries, with tests enforcing the copy constraints.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/docs-catalog.test.ts | Adds regression assertions to keep docs snippets, CLI prose, charts/examples, and audited marketing copy aligned with shipped behavior. |
| src/pages/marketing/themes.tsx | Updates hero copy to avoid over-claims and clarify accessibility testing expectations. |
| src/pages/marketing/production.tsx | Replaces “two outputs” messaging with explicit “two deployment paths” guidance and supporting paragraph. |
| src/pages/marketing/platform.tsx | Refines package/peer-boundary messaging to match installed peer dependency declarations. |
| src/pages/marketing/home.tsx | Adjusts hero lede to reflect explicit page registry framing. |
| src/pages/marketing/full-stack.tsx | Updates composition-root messaging to match shipped architecture claims. |
| src/pages/docs/usage-guide.ts | Updates multiple snippets (schema, router query, form uploads, UI patterns) and adds page-specific chart usage examples. |
| src/pages/docs/release-notes.ts | Renames and rewrites release-note-style content into concrete upgrade guidance entries. |
| src/pages/docs/page.tsx | Updates docs landing section/anchor rendering to show “Upgrade guidance” instead of “Release notes”. |
| src/pages/docs/content-overrides.ts | Revises CLI/dependency-maintenance prose to match current CLI behavior (including --force/-f). |
| src/pages/docs/catalog.ts | Updates docs landing TOC entry from release-notes to upgrade-guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Validation