Repository navigation
Clarify ghost's brand context router positioning - #304
Merged
Merged
Conversation
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.
Category: improvement
User Impact: New users can understand ghost, record one brand decision, and use it with their existing agent.
Problem: The READMEs mixed consumer setup with implementation detail and repeated the product thesis. Public descriptions also blurred the distinction between the agent selecting guidance and ghost delivering it.
Solution: Describe ghost as a brand context router for agents across GitHub, npm, and the site opening. Lead the READMEs with setup, a confirmed payment-failure rule that applies across email/errors/support, and reviewing the result; link out for technical detail. No CLI, API, or package-format behavior changes.
Validation:
pnpm run quality:all: passed through the pre-push hook, including builds, package/release checks, workspace checks, and guidance validation.pnpm test: 332 passed, 1 skipped.git diff --check: passed. Existing non-blocking lint and cover-policy warnings remain unchanged.Changeset: added
.changeset/plain-readme.mdas a patch for@design-intelligence/ghost.ghost Review:
ghost checkcommand; package validation passed throughquality:all.node packages/ghost/dist/bin.js review --base origin/main --package apps/docs/.ghost --node principles --node composition --node visual-system: advisory packet assessed against the copy-only site changes. Typography, layout, materials, and motion remain unchanged.docs-sitenode. These are advisory coverage gaps, not failed checks.File changes
README.md: consumer-first walkthrough, router positioning, cross-task example, concise references.packages/ghost/README.md: same consumer story with absolute links for npm.apps/docs/src/components/Hero.astro: retain the original "likeliest thing" hero line, with router positioning and explicit agent-selection/CLI-delivery wording in the explanation below.apps/docs/src/layouts/Base.astro: align the default title and description.package.jsonandpackages/ghost/package.json: align package descriptions without changing commands or dependencies..changeset/plain-readme.md: release note for the public documentation update.Screenshots/Demos: Desktop and mobile screenshots inspected locally; not attached. The README includes a runnable guidance example.