docs: the local development loop - #197
Open
barryroodt wants to merge 1 commit into
Open
Conversation
README gets a "Local development loop" section covering the three agent inputs and how to override each: edit the skills tree and just run, build the mcp repo anywhere and pass --mcp, serve docs from your own supabase/supabase checkout and pass --content-api. It states where the keys go, and that `compare` is a screen rather than causal proof. It also records the one live limitation: `docs seed` needs a docs checkout carrying supabase/supabase#48364, which is still open. Without it fetchAllSources unconditionally awaits the lint-warnings source, whose loader needs the docs GitHub App, and a shared Promise.all turns that into a full abort before any embedding, so a failed attempt costs nothing. Two upstream rough edges are named rather than glossed: the seed exits 0 while silently failing 22 reference pages whose sections exceed the 8192-token embedding limit, and a local index has no partner-integration pages because that source reads the hosted misc project. AGENTS.md is the agent-facing version: which loop to run for a given kind of change, the spend rules for anything that costs money, and the same limitations stated as operational guidance. CLAUDE.md points at it. Verified: smoke 27/27, tsc and biome clean.
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
1 participant
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.
Stack 5/5 for #128. Base: #196. Prose only, no code.
README gets a "Local development loop" section covering the three agent inputs and how to override each: edit the skills tree and just run, build the mcp repo anywhere and pass
--mcp, serve docs from your own supabase/supabase checkout and pass--content-api. It says where the keys go, and thatcompareis a screen rather than causal proof.It also records the one live limitation.
docs seedneeds a docs checkout carrying supabase/supabase#48364, which is still open: without itfetchAllSources()unconditionally awaits the lint-warnings source, whose loader needs the docs GitHub App, and a sharedPromise.allturns that into a full abort before any embedding. A failed attempt costs nothing. @raulb asked for this caveat to come out once that ships, so it is a one-line follow-up then.Two upstream rough edges are named rather than glossed: the seed exits 0 while silently failing 22 reference pages whose sections exceed the 8192-token embedding limit, and a local index has no partner-integration pages because that source reads the hosted misc project.
AGENTS.mdis the agent-facing version, with which loop to run for a given change, the spend rules for anything costing money, and the same limitations as operational guidance.CLAUDE.mdpoints at it.The single-page HTML design brief that was in the original #128 is deliberately not here; it lives outside the repo now.
Verified
tsc --noEmitandbiome checkclean (no code changed)