Repository navigation
docs: agent guides and a Panda reference per example - #5
Merged
Merged
Conversation
Coding agents kept guessing at Panda and mixing up the three setups. Each example now ships an AGENTS.md with wiring for that setup and a PANDA.md with the authoring API, the v2-beta facts these examples rely on, and the mistakes to avoid. PANDA.md and AGENTS.md are copied into every example folder so a single folder pulled with degit stays complete. The root AGENTS.md points to both and notes the copies are kept in sync.
Rewrite the Panda guide around the errors agents actually make: dynamic values that emit no CSS, Tailwind class strings, `var(--x)` instead of token names, `:hover` instead of `_hover`, `md:` prefixes, and recipe variant props that only emit defaultVariants. Each is a wrong-vs-right pair with a one-line why.
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
2 participants
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.
📚 Description
Coding agents kept guessing at Panda and mixing up the three examples: importing
cssfrom the wrong place, writing Tailwind class strings, passing computed values that emit no CSS, editing generatedstyled-system/output, adding Panda to the app that has none. This adds guidance that heads those off.Every example now has:
AGENTS.md— the wiring for that setup and the mistakes to avoid.PANDA.md— how to write Panda here, framed around the errors people actually make. Each trap is a wrong-vs-right pair: dynamic values that generate nothing,var(--x)vs token names,:hovervs_hover,md:prefixes vs responsive objects, recipe variant props that only emitdefaultVariants. Plus the v2-beta facts these examples rely on (panda lib,designSystem, presets aren't auto-injected).Both are copied into each example folder so a single folder pulled with
degitstays complete. The rootAGENTS.mdpoints to both and notes the copies are kept in sync.⛳️ Current behavior
Only a root
AGENTS.mdwith repo-wide conventions. No per-example guidance and no Panda reference, so anyone working inside one example had to infer how it's wired and relearn Panda's rules.🚀 New behavior
Per-example
AGENTS.mdandPANDA.md, each folder self-contained fordegit. RootAGENTS.mdgains a "Writing Panda" pointer.💣 Is this a breaking change?
No. Docs only. No source, config, or dependency changes.
📝 Additional information
The three
PANDA.mdcopies are intentional duplicates — the repo already duplicates dotfiles per example for the standalone model. Edit them together; the rootAGENTS.mdsays so.