Skip to content

Commit 85f27b1

Browse files
staging-devin-ai-integration[bot]streamkit-devinstreamer45
authored
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

23 files changed

+781
-185
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2025 StreamKit Contributors
3+
4+
SPDX-License-Identifier: MPL-2.0
5+
-->
6+
7+
---
8+
name: adding-plugins
9+
description: Checklist for making a StreamKit plugin official and downloadable from the registry. Use when adding a new native plugin or updating an existing one for marketplace distribution.
10+
---
11+
12+
For the full plugin addition checklist, see [guide.md](guide.md).
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../agent_docs/adding-plugins.md
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2025 StreamKit Contributors
3+
4+
SPDX-License-Identifier: MPL-2.0
5+
-->
6+
7+
---
8+
name: architecture
9+
description: StreamKit crate relationships, data flow, key abstractions, and UI architecture. Use when understanding how the codebase is structured, how pipelines flow from YAML to execution, or how crates depend on each other.
10+
---
11+
12+
For the full architecture guide, see [guide.md](guide.md).
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../agent_docs/architecture.md
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2025 StreamKit Contributors
3+
4+
SPDX-License-Identifier: MPL-2.0
5+
-->
6+
7+
---
8+
name: common-pitfalls
9+
description: Known mistakes that coding agents frequently make in the StreamKit codebase. Use before starting any task to avoid wasted effort — covers WebSocket vs REST state, perf baselines, Bun-only tooling, SPDX headers, lint suppressions, and React.memo barriers.
10+
---
11+
12+
For the full pitfalls guide, see [guide.md](guide.md).
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../agent_docs/common-pitfalls.md
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2025 StreamKit Contributors
3+
4+
SPDX-License-Identifier: MPL-2.0
5+
-->
6+
7+
---
8+
name: e2e-testing
9+
description: Running StreamKit E2E tests with Playwright. Use when writing, running, or debugging end-to-end tests, or when dealing with headless browser issues like IntersectionObserver visibility.
10+
---
11+
12+
For the full E2E testing guide, see [guide.md](guide.md).
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../agent_docs/e2e-testing.md
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2025 StreamKit Contributors
3+
4+
SPDX-License-Identifier: MPL-2.0
5+
-->
6+
7+
---
8+
name: render-performance
9+
description: StreamKit render performance profiling infrastructure. Use when touching compositor hooks or components, optimizing render performance, or investigating cascade re-renders in React.memo'd components.
10+
---
11+
12+
For the full render performance guide, see [guide.md](guide.md).
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../agent_docs/render-performance.md

0 commit comments

Comments
 (0)