Repository navigation
Restructure the public README - #311
Merged
Merged
Conversation
Reframe the root and npm READMEs around brand intelligence, the gather-and-pull workflow, a direct quickstart, and the repository map.
Added an image and expanded on the functionality of the .ghost package in the README.
Removed duplicate guidance animation image and cleaned up the text.
Updated the README to clarify the role of agents and the ghost tool in providing brand context and guidance.
Removed duplicate note about ghost being an early preview.
chailandau
force-pushed
the
chai/repo-front-door
branch
from
November 4, 2026 21:18
3652630 to
6a7d900
Compare
Removed duplicate note about ghost being an early preview.
Clarify the role of _ghost_ in separating mechanics from guidance, and update the explanation of the .ghost/ package.
Keep the introduction, workflow, and package outline concise. Link setup and detailed usage to existing guides so readers can choose how far to go. Co-authored-by: Sol 5.6 <2be45693458a7d45edf11882226b8bc6246772f8719faed540576070d8b0464f@buzz.block.builderlab.xyz>
Reserve space for side-by-side results from the same prompt, with and without ghost guidance.
Updated README to improve branding emphasis and formatting.
Signed-off-by: Sol 5.6 <2be45693458a7d45edf11882226b8bc6246772f8719faed540576070d8b0464f@buzz.block.builderlab.xyz>
chailandau
force-pushed
the
chai/repo-front-door
branch
from
November 5, 2026 03:09
0611401 to
d230b25
Compare
chailandau
marked this pull request as ready for review
November 5, 2026 03:12
Relabel the package schema links so they describe their actual target. Direct readers to the built-in help for current commands and flags. Signed-off-by: Sol 5.6 <2be45693458a7d45edf11882226b8bc6246772f8719faed540576070d8b0464f@buzz.block.builderlab.xyz>
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.
Why
The public README explains ghost as a tool before it explains the problem it solves. New readers need a faster path from the brand-intelligence premise to the gather, select, and pull workflow.
What
This restructures the root and npm READMEs around the positioning, workflow, quickstart, comparisons, supported agents, and repository map. It also adds a patch changeset for the public package documentation.
How
The two README surfaces keep the same story, with repository-relative links in the root and absolute GitHub links on npm. The examples use the current starter package and public CLI commands.
Risk
Low. This changes documentation and package metadata only. The PR is a draft so the copy and visual placement can be reviewed before merge.
Testing
pnpm check:terminology,git diff --check, and local README link checks passed. The full local suite could not run because this worktree's dependency install is incomplete (tsc,biome, andvitestare unavailable), and npm access was blocked by the dependency-confusion gate.Bigger picture
A follow-up pass will address the draft copy review and add the approved guidance-selection visual.
Generated with Goose