[PF-1997] Add .picasso/ v2 rules and absolute-URL llms.txt index#5018
Open
dulishkovych wants to merge 4 commits into
Open
[PF-1997] Add .picasso/ v2 rules and absolute-URL llms.txt index#5018dulishkovych wants to merge 4 commits into
dulishkovych wants to merge 4 commits into
Conversation
Optimize the LLM index and .picasso/ rules for AI agents (PF-1997). - llms.txt links are now absolute URLs via LLM_DOCS_BASE_URL (default the production gh-pages URL, env-overridable for PR previews), so the index resolves from anywhere without a local copy. - Add canonical .picasso/ v2 rules built around fetch-on-demand from the hosted index instead of vendoring the ~1 MB doc tree, with a changelog vs v1 and removal of v1's stale patterns/tokens/96-docs pointers. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Contributor
Tell consumers (and their AI agents) to wire CLAUDE.md / .cursor rules to the hosted Picasso LLM docs after install — the README is the first touchpoint and also feeds llm-docs/initial-setup.md. Closes the discovery gap so the existing docs are actually reachable. (PF-1997) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The root README is the GitHub landing page (and what the API serves as the repo README), so add a short pointer to the hosted LLM index and the rules. Keeps the full setup snippet in one place (package README + .picasso/rules.md) to avoid drift. (PF-1997) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Drop the standalone CHANGELOG.md and README.md: the repo versions via changesets (no per-folder changelog convention), and the adoption/setup info now lives in the package README. Fold a short "changed from v1" note into rules.md so the v1-delta is still recorded in one place. (PF-1997) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
📖 Storybook Preview 🚀 Your Storybook preview is ready: View Storybook 📍 Preview URL: This preview is updated automatically when you push changes to this PR. |
azebich
approved these changes
Jun 24, 2026
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.
PF-1997
Description
This is the Foundation PR (1 of ~6) for making Picasso usable by AI coding agents (Cursor, Claude Code, …). The goal of the effort: agents reliably generate correct, on-brand Picasso instead of guessing props, reaching for raw HTML, or importing from the wrong package.
We already generate LLM docs (
llms.txt+ per-component pages) and host them on gh-pages — but nothing tells an agent they exist, and v1 "adoption" meant copy-pasting the whole ~1 MB doc tree into a consumer repo. This PR fixes discovery and reachability:.picasso/rules.md— a single canonical, always-on ruleset for agents: how to look up docs (fetch on demand), package imports, and mandatory usage rules. Replaces the v1 per-tool copies that had already drifted.README.md(GitHub landing) andpackages/picasso/README.md(npm + what the generator copies intollm-docs/initial-setup.md) now tell an agent to wireCLAUDE.md/.cursorrules to the hosted docs. The package README carries the copy-paste setup snippet; the others point to it (single source, no drift).llms.txt— the generator (bin/doc-gen/markdown-renderer.mjs) now emits absolute links viaLLM_DOCS_BASE_URL(default the production gh-pages URL, env-overridable for previews), so the index resolves from anywhere and agents fetch the one component doc they need without vendoring the tree.What this PR deliberately does NOT do (tracked as later PRs on the same branch): rebuild the generator to trim Storybook-demo bloat + add an authored per-component layer (usage + composition recipes), top-20 scoping,
llms-full.txt, packaging the rules into the npm package, and Skills.How to test
…/prs/5018/llm-docs/llms.txtshows absolute URLs, while production…/picasso/llm-docs/llms.txtis unchanged (proves nothing leaks to prod).pnpm generate:llm-docs→ confirmllm-docs/llms.txtlinks are absolute (https://toptal.github.io/picasso/llm-docs/components/<name>.md).LLM_DOCS_BASE_URL=https://example.test/docs node bin/generate-docs.mjs→ links use that base (trailing slash normalized)..picasso/rules.mdand the new "Using Picasso with AI coding agents" section inpackages/picasso/README.md.Screenshots
N/A — no visual/UI changes (docs-generation tooling + agent rules only).
Development checks
bin/tooling + repo-level.picasso/+ READMEs)picasso-tailwind-mergerequires major update (check itsREADME.md) — N/A, untouchedpropsin component with documentation — N/A, no component changesexamplesfor component — N/A, no component changesllms.txtoutput + previewBreaking change
Alpha packages
Manually trigger the publish.yml workflow to publish alpha packages. Specify pull request number as a parameter (only digits, e.g.
123).PR Review Guidelines
When to approve? ✅
You are OK with merging this PR and
nit:to your comment. (ex.nit: I'd rename this variable from makeCircle to getCircle)When to request changes? ❌
You are not OK with merging this PR because
When to comment (neither ✅ nor ❌)
You want your comments to be addressed before merging this PR in cases like:
How to handle the comments?