Commit 85f27b1
docs(agents): restructure AGENTS.md with progressive disclosure and skills.sh integration (#298)
* docs(agents): restructure AGENTS.md with progressive disclosure and skills.sh integration
- Rewrite AGENTS.md to be concise (~90 lines, down from 196) following
HumanLayer best practices: WHAT/WHY/HOW structure, universally-applicable
instructions only, progressive disclosure index
- Add codebase map, tech stack summary, and verification commands table
- Create agent_docs/ directory with domain-specific guides:
- architecture.md: crate relationships, data flow, key abstractions
- common-pitfalls.md: known agent mistakes (WS state, perf baselines, etc.)
- e2e-testing.md: E2E setup and headless-browser pitfalls (moved from AGENTS.md)
- render-performance.md: profiling infrastructure docs (moved from AGENTS.md)
- adding-plugins.md: plugin addition checklist (moved from AGENTS.md)
- ui-development.md: React/Zustand/Jotai patterns, state management rules
- skills-setup.md: skills.sh integration with recommended packages
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* fix(agents): correct state management docs, knip command, e2e prereqs, crate deps, and stale path
- Fix Zustand/Jotai state management descriptions in architecture.md,
common-pitfalls.md, and ui-development.md to reflect the actual code:
Jotai atoms are the primary store for high-frequency per-node data,
Zustand handles pipeline structure with transitional compat writes
- Fix just knip -> just knip-ui in AGENTS.md verification table
- Add install-e2e and install-playwright prerequisites to e2e-testing.md
- Fix crate dependency diagram direction in architecture.md (arrows now
point from dependent to dependency)
- Replace stale marketplace/PORTABILITY_REVIEW.md reference with
verify_bundles.py in adding-plugins.md
- Fix React Query scope: drop 'marketplace' (uses useState/useEffect)
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* fix(agents): correct state layer count from three to four in ui-development.md
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* docs(agents): add CLAUDE.md that imports AGENTS.md for Claude Code compatibility
Per Anthropic docs (https://code.claude.com/docs/en/memory#agents-md),
Claude Code reads CLAUDE.md not AGENTS.md. This file imports AGENTS.md
so both Claude Code and other agents read the same instructions without
duplication.
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* docs(agents): add .claude/skills/ with symlinks to agent_docs, add skit-cli to maps
- Create .claude/skills/ with thin SKILL.md wrappers (frontmatter only)
that symlink guide.md -> agent_docs/<name>.md. This gives Claude Code
progressive disclosure (name+description at startup, full content
on-demand) with zero content duplication.
- Add apps/skit-cli/ (streamkit-client) to codebase maps in AGENTS.md
and agent_docs/architecture.md.
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* fix(agents): add SPDX license headers to all .claude/skills/*/SKILL.md files
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* fix(agents): clarify skills install location and fix Rust lint command
- skills-setup.md: distinguish repo-maintained .claude/skills/ (committed,
symlinked to agent_docs/) from user-local skill installs. Warn against
running npx skills add into the tracked tree.
- AGENTS.md: replace inaccurate cargo clippy --workspace command with
just lint-skit, which matches the actual lint contract (per-crate
feature flags, --all-targets, license check).
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* fix(agents): address review feedback on samples/, Rust version, Docker, and models
- samples/ row: mention assets (audio, images, fonts, Slint files) not just pipelines
- Rust version: reference rust-toolchain.toml instead of hardcoding 1.92
- Docker: note that slim images don't bundle models but full images do
- adding-plugins.md: add step to upload models to HuggingFace repo
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* fix(agents): correct Docker image tag from -full to -demo
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
* fix(agents): add tests/ directory to codebase maps (from PR #279)
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
---------
Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-authored-by: StreamKit Devin <devin@streamkit.dev>
Co-authored-by: Claudio Costa <cstcld91@gmail.com>1 parent 3428471 commit 85f27b1
File tree
23 files changed
+781
-185
lines changed- .claude/skills
- adding-plugins
- architecture
- common-pitfalls
- e2e-testing
- render-performance
- skills-setup
- ui-development
- agent_docs
23 files changed
+781
-185
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
0 commit comments