@every-env/compound-plugin 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +37 -0
- package/.github/workflows/deploy-docs.yml +39 -0
- package/AGENTS.md +48 -0
- package/CLAUDE.md +380 -0
- package/LICENSE +21 -0
- package/README.md +65 -0
- package/bun.lock +30 -0
- package/docs/css/docs.css +675 -0
- package/docs/css/style.css +2886 -0
- package/docs/index.html +1046 -0
- package/docs/js/main.js +225 -0
- package/docs/pages/agents.html +649 -0
- package/docs/pages/changelog.html +495 -0
- package/docs/pages/commands.html +523 -0
- package/docs/pages/getting-started.html +582 -0
- package/docs/pages/mcp-servers.html +409 -0
- package/docs/pages/skills.html +611 -0
- package/docs/solutions/plugin-versioning-requirements.md +77 -0
- package/docs/specs/claude-code.md +67 -0
- package/docs/specs/codex.md +59 -0
- package/docs/specs/opencode.md +57 -0
- package/package.json +26 -0
- package/plans/grow-your-own-garden-plugin-architecture.md +102 -0
- package/plans/landing-page-launchkit-refresh.md +279 -0
- package/plugins/coding-tutor/.claude-plugin/plugin.json +9 -0
- package/plugins/coding-tutor/README.md +37 -0
- package/plugins/coding-tutor/commands/quiz-me.md +1 -0
- package/plugins/coding-tutor/commands/sync-tutorials.md +25 -0
- package/plugins/coding-tutor/commands/teach-me.md +1 -0
- package/plugins/coding-tutor/skills/coding-tutor/SKILL.md +214 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/create_tutorial.py +207 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/index_tutorials.py +193 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/quiz_priority.py +190 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/setup_tutorials.py +118 -0
- package/plugins/compound-engineering/.claude-plugin/plugin.json +33 -0
- package/plugins/compound-engineering/CHANGELOG.md +393 -0
- package/plugins/compound-engineering/CLAUDE.md +90 -0
- package/plugins/compound-engineering/LICENSE +21 -0
- package/plugins/compound-engineering/README.md +219 -0
- package/plugins/compound-engineering/agents/design/design-implementation-reviewer.md +94 -0
- package/plugins/compound-engineering/agents/design/design-iterator.md +197 -0
- package/plugins/compound-engineering/agents/design/figma-design-sync.md +172 -0
- package/plugins/compound-engineering/agents/docs/ankane-readme-writer.md +50 -0
- package/plugins/compound-engineering/agents/research/best-practices-researcher.md +100 -0
- package/plugins/compound-engineering/agents/research/framework-docs-researcher.md +83 -0
- package/plugins/compound-engineering/agents/research/git-history-analyzer.md +42 -0
- package/plugins/compound-engineering/agents/research/repo-research-analyst.md +113 -0
- package/plugins/compound-engineering/agents/review/agent-native-reviewer.md +246 -0
- package/plugins/compound-engineering/agents/review/architecture-strategist.md +52 -0
- package/plugins/compound-engineering/agents/review/code-simplicity-reviewer.md +85 -0
- package/plugins/compound-engineering/agents/review/data-integrity-guardian.md +70 -0
- package/plugins/compound-engineering/agents/review/data-migration-expert.md +97 -0
- package/plugins/compound-engineering/agents/review/deployment-verification-agent.md +159 -0
- package/plugins/compound-engineering/agents/review/dhh-rails-reviewer.md +45 -0
- package/plugins/compound-engineering/agents/review/julik-frontend-races-reviewer.md +222 -0
- package/plugins/compound-engineering/agents/review/kieran-python-reviewer.md +104 -0
- package/plugins/compound-engineering/agents/review/kieran-rails-reviewer.md +86 -0
- package/plugins/compound-engineering/agents/review/kieran-typescript-reviewer.md +95 -0
- package/plugins/compound-engineering/agents/review/pattern-recognition-specialist.md +57 -0
- package/plugins/compound-engineering/agents/review/performance-oracle.md +110 -0
- package/plugins/compound-engineering/agents/review/security-sentinel.md +93 -0
- package/plugins/compound-engineering/agents/workflow/bug-reproduction-validator.md +67 -0
- package/plugins/compound-engineering/agents/workflow/every-style-editor.md +64 -0
- package/plugins/compound-engineering/agents/workflow/lint.md +16 -0
- package/plugins/compound-engineering/agents/workflow/pr-comment-resolver.md +69 -0
- package/plugins/compound-engineering/agents/workflow/spec-flow-analyzer.md +113 -0
- package/plugins/compound-engineering/commands/agent-native-audit.md +277 -0
- package/plugins/compound-engineering/commands/changelog.md +137 -0
- package/plugins/compound-engineering/commands/create-agent-skill.md +8 -0
- package/plugins/compound-engineering/commands/deepen-plan.md +546 -0
- package/plugins/compound-engineering/commands/deploy-docs.md +112 -0
- package/plugins/compound-engineering/commands/feature-video.md +342 -0
- package/plugins/compound-engineering/commands/generate_command.md +162 -0
- package/plugins/compound-engineering/commands/heal-skill.md +142 -0
- package/plugins/compound-engineering/commands/lfg.md +19 -0
- package/plugins/compound-engineering/commands/plan_review.md +7 -0
- package/plugins/compound-engineering/commands/release-docs.md +211 -0
- package/plugins/compound-engineering/commands/report-bug.md +150 -0
- package/plugins/compound-engineering/commands/reproduce-bug.md +99 -0
- package/plugins/compound-engineering/commands/resolve_parallel.md +34 -0
- package/plugins/compound-engineering/commands/resolve_pr_parallel.md +49 -0
- package/plugins/compound-engineering/commands/resolve_todo_parallel.md +35 -0
- package/plugins/compound-engineering/commands/test-browser.md +339 -0
- package/plugins/compound-engineering/commands/triage.md +310 -0
- package/plugins/compound-engineering/commands/workflows/compound.md +202 -0
- package/plugins/compound-engineering/commands/workflows/plan.md +466 -0
- package/plugins/compound-engineering/commands/workflows/review.md +514 -0
- package/plugins/compound-engineering/commands/workflows/work.md +363 -0
- package/plugins/compound-engineering/commands/xcode-test.md +331 -0
- package/plugins/compound-engineering/skills/agent-browser/SKILL.md +223 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/SKILL.md +435 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/action-parity-discipline.md +409 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/agent-execution-patterns.md +467 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/agent-native-testing.md +582 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/architecture-patterns.md +478 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/dynamic-context-injection.md +338 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/files-universal-interface.md +301 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/from-primitives-to-domain-tools.md +359 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/mcp-tool-design.md +506 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/mobile-patterns.md +871 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/product-implications.md +443 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/refactoring-to-prompt-native.md +317 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/self-modification.md +269 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/shared-workspace-architecture.md +680 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/system-prompt-design.md +250 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/SKILL.md +184 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/database-adapters.md +231 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/module-organization.md +121 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/rails-integration.md +183 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/resources.md +119 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/testing-patterns.md +261 -0
- package/plugins/compound-engineering/skills/compound-docs/SKILL.md +510 -0
- package/plugins/compound-engineering/skills/compound-docs/assets/critical-pattern-template.md +34 -0
- package/plugins/compound-engineering/skills/compound-docs/assets/resolution-template.md +93 -0
- package/plugins/compound-engineering/skills/compound-docs/references/yaml-schema.md +65 -0
- package/plugins/compound-engineering/skills/compound-docs/schema.yaml +176 -0
- package/plugins/compound-engineering/skills/create-agent-skills/SKILL.md +299 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/api-security.md +226 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/be-clear-and-direct.md +531 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/best-practices.md +404 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/common-patterns.md +595 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/core-principles.md +437 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/executable-code.md +175 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/iteration-and-testing.md +474 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/official-spec.md +185 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/recommended-structure.md +168 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/skill-structure.md +372 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/using-scripts.md +113 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/using-templates.md +112 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/workflows-and-validation.md +510 -0
- package/plugins/compound-engineering/skills/create-agent-skills/templates/router-skill.md +73 -0
- package/plugins/compound-engineering/skills/create-agent-skills/templates/simple-skill.md +33 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-reference.md +96 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-script.md +93 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-template.md +74 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-workflow.md +120 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/audit-skill.md +138 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/create-domain-expertise-skill.md +605 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/create-new-skill.md +191 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/get-guidance.md +121 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/upgrade-to-router.md +161 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/verify-skill.md +204 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/SKILL.md +185 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/architecture.md +653 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/controllers.md +303 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/frontend.md +510 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/gems.md +266 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/models.md +359 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/testing.md +338 -0
- package/plugins/compound-engineering/skills/dspy-ruby/SKILL.md +594 -0
- package/plugins/compound-engineering/skills/dspy-ruby/assets/config-template.rb +359 -0
- package/plugins/compound-engineering/skills/dspy-ruby/assets/module-template.rb +326 -0
- package/plugins/compound-engineering/skills/dspy-ruby/assets/signature-template.rb +143 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/core-concepts.md +265 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/optimization.md +623 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/providers.md +338 -0
- package/plugins/compound-engineering/skills/every-style-editor/SKILL.md +134 -0
- package/plugins/compound-engineering/skills/every-style-editor/references/EVERY_WRITE_STYLE.md +529 -0
- package/plugins/compound-engineering/skills/file-todos/SKILL.md +251 -0
- package/plugins/compound-engineering/skills/file-todos/assets/todo-template.md +155 -0
- package/plugins/compound-engineering/skills/frontend-design/SKILL.md +42 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/SKILL.md +237 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/requirements.txt +2 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/compose_images.py +157 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/edit_image.py +144 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/gemini_images.py +263 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/generate_image.py +133 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/multi_turn_chat.py +216 -0
- package/plugins/compound-engineering/skills/git-worktree/SKILL.md +302 -0
- package/plugins/compound-engineering/skills/git-worktree/scripts/worktree-manager.sh +345 -0
- package/plugins/compound-engineering/skills/rclone/SKILL.md +150 -0
- package/plugins/compound-engineering/skills/rclone/scripts/check_setup.sh +60 -0
- package/plugins/compound-engineering/skills/skill-creator/SKILL.md +209 -0
- package/plugins/compound-engineering/skills/skill-creator/scripts/init_skill.py +303 -0
- package/plugins/compound-engineering/skills/skill-creator/scripts/package_skill.py +110 -0
- package/plugins/compound-engineering/skills/skill-creator/scripts/quick_validate.py +65 -0
- package/src/commands/convert.ts +156 -0
- package/src/commands/install.ts +221 -0
- package/src/commands/list.ts +37 -0
- package/src/converters/claude-to-codex.ts +124 -0
- package/src/converters/claude-to-opencode.ts +392 -0
- package/src/index.ts +20 -0
- package/src/parsers/claude.ts +248 -0
- package/src/targets/codex.ts +91 -0
- package/src/targets/index.ts +29 -0
- package/src/targets/opencode.ts +48 -0
- package/src/types/claude.ts +88 -0
- package/src/types/codex.ts +23 -0
- package/src/types/opencode.ts +54 -0
- package/src/utils/codex-agents.ts +64 -0
- package/src/utils/files.ts +64 -0
- package/src/utils/frontmatter.ts +65 -0
- package/tests/claude-parser.test.ts +89 -0
- package/tests/cli.test.ts +289 -0
- package/tests/codex-agents.test.ts +62 -0
- package/tests/codex-converter.test.ts +121 -0
- package/tests/codex-writer.test.ts +76 -0
- package/tests/converter.test.ts +171 -0
- package/tests/fixtures/custom-paths/.claude-plugin/plugin.json +8 -0
- package/tests/fixtures/custom-paths/agents/default-agent.md +5 -0
- package/tests/fixtures/custom-paths/commands/default-command.md +5 -0
- package/tests/fixtures/custom-paths/custom-agents/custom-agent.md +5 -0
- package/tests/fixtures/custom-paths/custom-commands/custom-command.md +5 -0
- package/tests/fixtures/custom-paths/custom-hooks/hooks.json +7 -0
- package/tests/fixtures/custom-paths/custom-skills/custom-skill/SKILL.md +5 -0
- package/tests/fixtures/custom-paths/hooks/hooks.json +7 -0
- package/tests/fixtures/custom-paths/skills/default-skill/SKILL.md +5 -0
- package/tests/fixtures/invalid-command-path/.claude-plugin/plugin.json +5 -0
- package/tests/fixtures/invalid-hooks-path/.claude-plugin/plugin.json +5 -0
- package/tests/fixtures/invalid-mcp-path/.claude-plugin/plugin.json +5 -0
- package/tests/fixtures/mcp-file/.claude-plugin/plugin.json +5 -0
- package/tests/fixtures/mcp-file/.mcp.json +6 -0
- package/tests/fixtures/sample-plugin/.claude-plugin/plugin.json +30 -0
- package/tests/fixtures/sample-plugin/agents/agent-one.md +10 -0
- package/tests/fixtures/sample-plugin/agents/security-reviewer.md +7 -0
- package/tests/fixtures/sample-plugin/commands/command-one.md +7 -0
- package/tests/fixtures/sample-plugin/commands/model-command.md +8 -0
- package/tests/fixtures/sample-plugin/commands/nested/command-two.md +9 -0
- package/tests/fixtures/sample-plugin/commands/pattern-command.md +7 -0
- package/tests/fixtures/sample-plugin/commands/skill-command.md +7 -0
- package/tests/fixtures/sample-plugin/commands/todo-command.md +7 -0
- package/tests/fixtures/sample-plugin/hooks/hooks.json +156 -0
- package/tests/fixtures/sample-plugin/skills/skill-one/SKILL.md +6 -0
- package/tests/frontmatter.test.ts +20 -0
- package/tests/opencode-writer.test.ts +62 -0
- package/tsconfig.json +14 -0
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Plugin Versioning and Documentation Requirements
|
|
3
|
+
category: workflow
|
|
4
|
+
tags: [versioning, changelog, readme, plugin, documentation]
|
|
5
|
+
created: 2025-11-24
|
|
6
|
+
severity: process
|
|
7
|
+
component: plugin-development
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Plugin Versioning and Documentation Requirements
|
|
11
|
+
|
|
12
|
+
## Problem
|
|
13
|
+
|
|
14
|
+
When making changes to the compound-engineering plugin, documentation can get out of sync with the actual components (agents, commands, skills). This leads to confusion about what's included in each version and makes it difficult to track changes over time.
|
|
15
|
+
|
|
16
|
+
## Solution
|
|
17
|
+
|
|
18
|
+
**Every change to the plugin MUST include:**
|
|
19
|
+
|
|
20
|
+
1. **Version bump in `plugin.json`**
|
|
21
|
+
- Follow semantic versioning (semver)
|
|
22
|
+
- MAJOR: Breaking changes or major reorganization
|
|
23
|
+
- MINOR: New agents, commands, or skills added
|
|
24
|
+
- PATCH: Bug fixes, documentation updates, minor improvements
|
|
25
|
+
|
|
26
|
+
2. **CHANGELOG.md update**
|
|
27
|
+
- Add entry under `## [Unreleased]` or new version section
|
|
28
|
+
- Use Keep a Changelog format
|
|
29
|
+
- Categories: Added, Changed, Deprecated, Removed, Fixed, Security
|
|
30
|
+
|
|
31
|
+
3. **README.md verification**
|
|
32
|
+
- Verify component counts match actual files
|
|
33
|
+
- Verify agent/command/skill tables are accurate
|
|
34
|
+
- Update descriptions if functionality changed
|
|
35
|
+
|
|
36
|
+
## Checklist for Plugin Changes
|
|
37
|
+
|
|
38
|
+
```markdown
|
|
39
|
+
Before committing changes to compound-engineering plugin:
|
|
40
|
+
|
|
41
|
+
- [ ] Version bumped in `.claude-plugin/plugin.json`
|
|
42
|
+
- [ ] CHANGELOG.md updated with changes
|
|
43
|
+
- [ ] README.md component counts verified
|
|
44
|
+
- [ ] README.md tables updated (if adding/removing/renaming)
|
|
45
|
+
- [ ] plugin.json description updated (if component counts changed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## File Locations
|
|
49
|
+
|
|
50
|
+
- Version: `.claude-plugin/plugin.json` → `"version": "X.Y.Z"`
|
|
51
|
+
- Changelog: `CHANGELOG.md`
|
|
52
|
+
- Readme: `README.md`
|
|
53
|
+
|
|
54
|
+
## Example Workflow
|
|
55
|
+
|
|
56
|
+
When adding a new agent:
|
|
57
|
+
|
|
58
|
+
1. Create the agent file in `agents/[category]/`
|
|
59
|
+
2. Bump version in `plugin.json` (minor version for new agent)
|
|
60
|
+
3. Add to CHANGELOG under `### Added`
|
|
61
|
+
4. Add row to README agent table
|
|
62
|
+
5. Update README component count
|
|
63
|
+
6. Update plugin.json description with new counts
|
|
64
|
+
|
|
65
|
+
## Prevention
|
|
66
|
+
|
|
67
|
+
This documentation serves as a reminder. When Claude Code works on this plugin, it should:
|
|
68
|
+
|
|
69
|
+
1. Check this doc before committing changes
|
|
70
|
+
2. Follow the checklist above
|
|
71
|
+
3. Never commit partial updates (all three files must be updated together)
|
|
72
|
+
|
|
73
|
+
## Related Files
|
|
74
|
+
|
|
75
|
+
- `/Users/kieranklaassen/every-marketplace/plugins/compound-engineering/.claude-plugin/plugin.json`
|
|
76
|
+
- `/Users/kieranklaassen/every-marketplace/plugins/compound-engineering/CHANGELOG.md`
|
|
77
|
+
- `/Users/kieranklaassen/every-marketplace/plugins/compound-engineering/README.md`
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Claude Code Plugin Spec
|
|
2
|
+
|
|
3
|
+
Last verified: 2026-01-21
|
|
4
|
+
|
|
5
|
+
## Primary sources
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
https://docs.claude.com/en/docs/claude-code/plugins-reference
|
|
9
|
+
https://docs.claude.com/en/docs/claude-code/hooks
|
|
10
|
+
https://docs.claude.com/en/docs/claude-code/slash-commands
|
|
11
|
+
https://docs.claude.com/en/docs/claude-code/skills
|
|
12
|
+
https://docs.claude.com/en/docs/claude-code/plugin-marketplaces
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Plugin layout and file locations
|
|
16
|
+
|
|
17
|
+
- A plugin root contains `.claude-plugin/plugin.json` and optional default directories like `commands/`, `agents/`, `skills/`, `hooks/`, plus `.mcp.json` and `.lsp.json` at the plugin root. citeturn2view7
|
|
18
|
+
- The `.claude-plugin/` directory only holds the manifest; component directories (commands/agents/skills/hooks) must be at the plugin root, not inside `.claude-plugin/`. citeturn2view7
|
|
19
|
+
- The reference table lists default locations and notes that `commands/` is the legacy home for skills; new skills should live under `skills/<name>/SKILL.md`. citeturn2view7
|
|
20
|
+
|
|
21
|
+
## Manifest schema (`.claude-plugin/plugin.json`)
|
|
22
|
+
|
|
23
|
+
- `name` is required and must be kebab-case with no spaces. citeturn2view8
|
|
24
|
+
- Metadata fields include `version`, `description`, `author`, `homepage`, `repository`, `license`, and `keywords`. citeturn2view8
|
|
25
|
+
- Component path fields include `commands`, `agents`, `skills`, `hooks`, `mcpServers`, `outputStyles`, and `lspServers`. These can be strings or arrays, or inline objects for hooks/MCP/LSP. citeturn2view8turn2view9
|
|
26
|
+
- Custom paths supplement defaults; they do not replace them, and all paths must be relative to the plugin root and start with `./`. citeturn2view9
|
|
27
|
+
|
|
28
|
+
## Commands (slash commands)
|
|
29
|
+
|
|
30
|
+
- Command files are Markdown with frontmatter. Supported frontmatter includes `allowed-tools`, `argument-hint`, `description`, `model`, and `disable-model-invocation`, each with documented defaults. citeturn6search0
|
|
31
|
+
|
|
32
|
+
## Skills (`skills/<name>/SKILL.md`)
|
|
33
|
+
|
|
34
|
+
- Skills are directories containing `SKILL.md` (plus optional support files). Skills and commands are auto-discovered when the plugin is installed. citeturn2view7
|
|
35
|
+
- Skills can be invoked with `/<skill-name>` and are stored in `~/.claude/skills` or `.claude/skills` (project-level); plugins can also ship skills. citeturn12view0
|
|
36
|
+
- Skill frontmatter examples include `name`, `description`, and optional `allowed-tools`. citeturn12view0
|
|
37
|
+
|
|
38
|
+
## Agents (`agents/*.md`)
|
|
39
|
+
|
|
40
|
+
- Agents are markdown files with frontmatter such as `description` and `capabilities`, plus descriptive content for when to invoke the agent. citeturn2view7
|
|
41
|
+
|
|
42
|
+
## Hooks (`hooks/hooks.json` or inline)
|
|
43
|
+
|
|
44
|
+
- Hooks can be provided in `hooks/hooks.json` or inline via the manifest. Hooks are organized by event → matcher → hook list. citeturn2view7
|
|
45
|
+
- Plugin hooks are merged with user and project hooks when the plugin is enabled, and matching hooks run in parallel. citeturn1search0
|
|
46
|
+
- Supported events include `PreToolUse`, `PostToolUse`, `PostToolUseFailure`, `PermissionRequest`, `UserPromptSubmit`, `Notification`, `Stop`, `SubagentStart`, `SubagentStop`, `Setup`, `SessionStart`, `SessionEnd`, and `PreCompact`. citeturn2view7
|
|
47
|
+
- Hook types include `command`, `prompt`, and `agent`. citeturn2view7
|
|
48
|
+
- Hooks can use `${CLAUDE_PLUGIN_ROOT}` to reference plugin files. citeturn1search0
|
|
49
|
+
|
|
50
|
+
## MCP servers
|
|
51
|
+
|
|
52
|
+
- Plugins can define MCP servers in `.mcp.json` or inline under `mcpServers` in the manifest. Configuration includes `command`, `args`, `env`, and `cwd`. citeturn2view7turn2view10
|
|
53
|
+
- Plugin MCP servers start automatically when enabled and appear as standard MCP tools. citeturn2view10
|
|
54
|
+
|
|
55
|
+
## LSP servers
|
|
56
|
+
|
|
57
|
+
- LSP servers can be defined in `.lsp.json` or inline in the manifest. Required fields include `command` and `extensionToLanguage`, with optional settings for transport, args, env, and timeouts. citeturn2view7turn2view10
|
|
58
|
+
|
|
59
|
+
## Plugin caching and path limits
|
|
60
|
+
|
|
61
|
+
- Claude Code copies plugin files into a cache directory instead of using them in place. Plugins cannot access paths outside the copied root (for example, `../shared-utils`). citeturn2view12
|
|
62
|
+
- To access external files, use symlinks inside the plugin directory or restructure your marketplace so the plugin root contains shared files. citeturn2view12
|
|
63
|
+
|
|
64
|
+
## Marketplace schema (`.claude-plugin/marketplace.json`)
|
|
65
|
+
|
|
66
|
+
- A marketplace JSON file lists plugins and includes fields for marketplace metadata and a `plugins` array. citeturn8view2
|
|
67
|
+
- Each plugin entry includes at least a `name` and `source` and can include additional manifest fields. citeturn8view2
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Codex Spec (Config, Prompts, Skills, MCP)
|
|
2
|
+
|
|
3
|
+
Last verified: 2026-01-21
|
|
4
|
+
|
|
5
|
+
## Primary sources
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
https://developers.openai.com/codex/config-basic
|
|
9
|
+
https://developers.openai.com/codex/config-advanced
|
|
10
|
+
https://developers.openai.com/codex/custom-prompts
|
|
11
|
+
https://developers.openai.com/codex/skills
|
|
12
|
+
https://developers.openai.com/codex/skills/create-skill
|
|
13
|
+
https://developers.openai.com/codex/guides/agents-md
|
|
14
|
+
https://developers.openai.com/codex/mcp
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Config location and precedence
|
|
18
|
+
|
|
19
|
+
- Codex reads local settings from `~/.codex/config.toml`, shared by the CLI and IDE extension. citeturn2view0
|
|
20
|
+
- Configuration precedence is: CLI flags → profile values → root-level values in `config.toml` → built-in defaults. citeturn2view0
|
|
21
|
+
- Codex stores local state under `CODEX_HOME` (defaults to `~/.codex`) and includes `config.toml` there. citeturn4view0
|
|
22
|
+
|
|
23
|
+
## Profiles and providers
|
|
24
|
+
|
|
25
|
+
- Profiles are defined under `[profiles.<name>]` and selected with `codex --profile <name>`. citeturn4view0
|
|
26
|
+
- A top-level `profile = "<name>"` sets the default profile; CLI flags can override it. citeturn4view0
|
|
27
|
+
- Profiles are experimental and not supported in the IDE extension. citeturn4view0
|
|
28
|
+
- Custom model providers can be defined with base URL, wire API, and optional headers, then referenced via `model_provider`. citeturn4view0
|
|
29
|
+
|
|
30
|
+
## Custom prompts (slash commands)
|
|
31
|
+
|
|
32
|
+
- Custom prompts are Markdown files stored under `~/.codex/prompts/`. citeturn3view0
|
|
33
|
+
- Custom prompts require explicit invocation and aren’t shared through the repository; use skills to share or auto-invoke. citeturn3view0
|
|
34
|
+
- Prompts are invoked as `/prompts:<name>` in the slash command UI. citeturn3view0
|
|
35
|
+
- Prompt front matter supports `description:` and `argument-hint:`. citeturn3view0turn2view3
|
|
36
|
+
- Prompt arguments support `$1`–`$9`, `$ARGUMENTS`, and named placeholders like `$FILE` provided as `KEY=value`. citeturn2view3
|
|
37
|
+
- Codex ignores non-Markdown files in the prompts directory. citeturn2view3
|
|
38
|
+
|
|
39
|
+
## AGENTS.md instructions
|
|
40
|
+
|
|
41
|
+
- Codex reads `AGENTS.md` files before doing any work and builds a combined instruction chain. citeturn3view1
|
|
42
|
+
- Discovery order: global (`~/.codex`, using `AGENTS.override.md` then `AGENTS.md`) then project directory traversal from repo root to CWD, with override > AGENTS > fallback names. citeturn3view1
|
|
43
|
+
- Codex concatenates files from root down; files closer to the working directory appear later and override earlier guidance. citeturn3view1
|
|
44
|
+
|
|
45
|
+
## Skills (Agent Skills)
|
|
46
|
+
|
|
47
|
+
- A skill is a folder containing `SKILL.md` plus optional `scripts/`, `references/`, and `assets/`. citeturn3view3turn3view4
|
|
48
|
+
- `SKILL.md` uses YAML front matter and requires `name` and `description`. citeturn3view3turn3view4
|
|
49
|
+
- Required fields are single-line with length limits (name ≤ 100 chars, description ≤ 500 chars). citeturn3view4
|
|
50
|
+
- At startup, Codex loads only each skill’s name/description; full content is injected when invoked. citeturn3view3turn3view4
|
|
51
|
+
- Skills can be repo-scoped in `.codex/skills/` or user-scoped in `~/.codex/skills/`. citeturn3view4
|
|
52
|
+
- Skills can be invoked explicitly using `/skills` or `$skill-name`. citeturn3view3
|
|
53
|
+
|
|
54
|
+
## MCP (Model Context Protocol)
|
|
55
|
+
|
|
56
|
+
- MCP configuration lives in `~/.codex/config.toml` and is shared by the CLI and IDE extension. citeturn3view2turn3view5
|
|
57
|
+
- Each server is configured under `[mcp_servers.<server-name>]`. citeturn3view5
|
|
58
|
+
- STDIO servers support `command` (required), `args`, `env`, `env_vars`, and `cwd`. citeturn3view5
|
|
59
|
+
- Streamable HTTP servers support `url` (required), `bearer_token_env_var`, `http_headers`, and `env_http_headers`. citeturn3view5
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# OpenCode Spec (Config, Agents, Plugins)
|
|
2
|
+
|
|
3
|
+
Last verified: 2026-01-21
|
|
4
|
+
|
|
5
|
+
## Primary sources
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
https://opencode.ai/docs/config
|
|
9
|
+
https://opencode.ai/docs/tools
|
|
10
|
+
https://opencode.ai/docs/permissions
|
|
11
|
+
https://opencode.ai/docs/plugins/
|
|
12
|
+
https://opencode.ai/docs/agents/
|
|
13
|
+
https://opencode.ai/config.json
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Config files and precedence
|
|
17
|
+
|
|
18
|
+
- OpenCode supports JSON and JSONC configs. citeturn10view0
|
|
19
|
+
- Config sources are merged (not replaced), with a defined precedence order from remote → global → custom → project → `.opencode` directories → inline overrides. citeturn10view0
|
|
20
|
+
- Global config is stored at `~/.config/opencode/opencode.json`, and project config is `opencode.json` in the project root. citeturn10view0
|
|
21
|
+
- Custom config file and directory can be provided via `OPENCODE_CONFIG` and `OPENCODE_CONFIG_DIR`. citeturn10view0
|
|
22
|
+
- The `.opencode` and `~/.config/opencode` directories use plural subdirectory names (`agents/`, `commands/`, `modes/`, `plugins/`, `skills/`, `tools/`, `themes/`), but singular names are also supported for backwards compatibility. citeturn10view0
|
|
23
|
+
|
|
24
|
+
## Core config keys
|
|
25
|
+
|
|
26
|
+
- `model` and `small_model` set the primary and lightweight models; `provider` configures provider options. citeturn10view0
|
|
27
|
+
- `tools` is still supported but deprecated; permissions are now the canonical control surface. citeturn1search0
|
|
28
|
+
- `permission` controls tool approvals and can be configured globally or per tool, including pattern-based rules. citeturn1search0
|
|
29
|
+
- `mcp`, `instructions`, and `disabled_providers` are supported config sections. citeturn1search5
|
|
30
|
+
- `plugin` can list npm packages to load at startup. citeturn1search2
|
|
31
|
+
|
|
32
|
+
## Tools
|
|
33
|
+
|
|
34
|
+
- OpenCode ships with built-in tools, and permissions determine whether each tool runs automatically, requires approval, or is denied. citeturn1search3turn1search0
|
|
35
|
+
- Tools are enabled by default; permissions provide the gating mechanism. citeturn1search3
|
|
36
|
+
|
|
37
|
+
## Permissions
|
|
38
|
+
|
|
39
|
+
- Permissions resolve to `allow`, `ask`, or `deny` and can be configured globally or per tool, with pattern-based rules. citeturn1search0
|
|
40
|
+
- Defaults are permissive, with special cases such as `.env` file reads. citeturn1search0
|
|
41
|
+
- Agent-level permissions override the global permission block. citeturn1search1turn1search0
|
|
42
|
+
|
|
43
|
+
## Agents
|
|
44
|
+
|
|
45
|
+
- Agents can be configured in `opencode.json` or as markdown files in `~/.config/opencode/agents/` or `.opencode/agents/`. citeturn1search1turn10view0
|
|
46
|
+
- Agent config supports `mode`, `model`, `temperature`, `tools`, and `permission`, and agent configs override global settings. citeturn1search1
|
|
47
|
+
- Model IDs use the `provider/model-id` format. citeturn1search1
|
|
48
|
+
|
|
49
|
+
## Plugins and events
|
|
50
|
+
|
|
51
|
+
- Local plugins are loaded from `.opencode/plugin/` (project) and `~/.config/opencode/plugin/` (global). npm plugins can be listed in `plugin` in `opencode.json`. citeturn1search2
|
|
52
|
+
- Plugins are loaded in a defined order across config and plugin directories. citeturn1search2
|
|
53
|
+
- Plugins export a function that returns a map of event handlers; the plugins doc lists supported event categories. citeturn1search2
|
|
54
|
+
|
|
55
|
+
## Notes for this repository
|
|
56
|
+
|
|
57
|
+
- Config docs describe plural subdirectory names, while the plugins doc uses `.opencode/plugin/`. This implies singular paths remain accepted for backwards compatibility, but plural paths are the canonical structure. citeturn10view0turn1search2
|
package/package.json
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@every-env/compound-plugin",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"private": false,
|
|
6
|
+
"bin": {
|
|
7
|
+
"compound-plugin": "./src/index.ts"
|
|
8
|
+
},
|
|
9
|
+
"publishConfig": {
|
|
10
|
+
"access": "public"
|
|
11
|
+
},
|
|
12
|
+
"scripts": {
|
|
13
|
+
"dev": "bun run src/index.ts",
|
|
14
|
+
"convert": "bun run src/index.ts convert",
|
|
15
|
+
"list": "bun run src/index.ts list",
|
|
16
|
+
"cli:install": "bun run src/index.ts install",
|
|
17
|
+
"test": "bun test"
|
|
18
|
+
},
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"citty": "^0.1.6",
|
|
21
|
+
"js-yaml": "^4.1.0"
|
|
22
|
+
},
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"bun-types": "^1.0.0"
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Grow Your Own Garden: Adaptive Agent Ecosystem
|
|
2
|
+
|
|
3
|
+
> **Issue:** https://github.com/kieranklaassen/compound-engineering-plugin/issues/20
|
|
4
|
+
|
|
5
|
+
## The Idea
|
|
6
|
+
|
|
7
|
+
Everyone grows their own garden, but we're all using the same process.
|
|
8
|
+
|
|
9
|
+
Start from a **seed** (minimal core: `/plan`, `/work`, `/review`, `/compound`). Each `/compound` loop can suggest adding agents based on what you're working on—like building up a test suite to prevent regressions, but for code review expertise.
|
|
10
|
+
|
|
11
|
+
## Current Problem
|
|
12
|
+
|
|
13
|
+
- Monolithic plugin: 24 agents, users use ~30%
|
|
14
|
+
- No personalization (same agents for Rails dev and Python dev)
|
|
15
|
+
- Static collection that doesn't adapt
|
|
16
|
+
|
|
17
|
+
## Proposed Solution
|
|
18
|
+
|
|
19
|
+
### The Seed (Core Plugin)
|
|
20
|
+
|
|
21
|
+
4 commands + minimal agents:
|
|
22
|
+
|
|
23
|
+
| Component | What's Included |
|
|
24
|
+
|-----------|-----------------|
|
|
25
|
+
| Commands | `/plan`, `/work`, `/review`, `/compound` |
|
|
26
|
+
| Review Agents | security, performance, simplicity, architecture, patterns |
|
|
27
|
+
| Research Agents | best-practices, framework-docs, git-history, repo-analyst |
|
|
28
|
+
| Skills | compound-docs, file-todos, git-worktree |
|
|
29
|
+
| MCP Servers | playwright, context7 |
|
|
30
|
+
|
|
31
|
+
### The Growth Loop
|
|
32
|
+
|
|
33
|
+
After each `/compound`:
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
✅ Learning documented
|
|
37
|
+
|
|
38
|
+
💡 It looks like you're using Rails.
|
|
39
|
+
Would you like to add the "DHH Rails Reviewer"?
|
|
40
|
+
|
|
41
|
+
[y] Yes [n] No [x] Never ask
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Three sources of new agents:
|
|
45
|
+
1. **Predefined** - "You're using Rails, add DHH reviewer?"
|
|
46
|
+
2. **Dynamic** - "You're using actor model, create an expert?"
|
|
47
|
+
3. **Custom** - "Want to create an agent for this pattern?"
|
|
48
|
+
|
|
49
|
+
### Agent Storage
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
.claude/agents/ → Project-specific (highest priority)
|
|
53
|
+
~/.claude/agents/ → User's garden
|
|
54
|
+
plugin/agents/ → From installed plugins
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Implementation Phases
|
|
58
|
+
|
|
59
|
+
### Phase 1: Split the Plugin
|
|
60
|
+
- Create `agent-library/` with framework-specific agents (Rails, Python, TypeScript, Frontend)
|
|
61
|
+
- Keep `compound-engineering` as core with universal agents
|
|
62
|
+
- No breaking changes—existing users unaffected
|
|
63
|
+
|
|
64
|
+
### Phase 2: Agent Discovery
|
|
65
|
+
- `/review` discovers agents from all three locations
|
|
66
|
+
- Project agents override user agents override plugin agents
|
|
67
|
+
|
|
68
|
+
### Phase 3: Growth via /compound
|
|
69
|
+
- Detect tech stack (Gemfile, package.json, etc.)
|
|
70
|
+
- Suggest relevant agents after documenting learnings
|
|
71
|
+
- Install accepted agents to `~/.claude/agents/`
|
|
72
|
+
|
|
73
|
+
### Phase 4: Management
|
|
74
|
+
- `/agents list` - See your garden
|
|
75
|
+
- `/agents add <name>` - Add from library
|
|
76
|
+
- `/agents disable <name>` - Temporarily disable
|
|
77
|
+
|
|
78
|
+
## What Goes Where
|
|
79
|
+
|
|
80
|
+
**Core (seed):** 11 framework-agnostic agents
|
|
81
|
+
- security-sentinel, performance-oracle, code-simplicity-reviewer
|
|
82
|
+
- architecture-strategist, pattern-recognition-specialist
|
|
83
|
+
- 4 research agents, 2 workflow agents
|
|
84
|
+
|
|
85
|
+
**Agent Library:** 10 specialized agents
|
|
86
|
+
- Rails: kieran-rails, dhh-rails, data-integrity (3)
|
|
87
|
+
- Python: kieran-python (1)
|
|
88
|
+
- TypeScript: kieran-typescript (1)
|
|
89
|
+
- Frontend: julik-races, design-iterator, design-reviewer, figma-sync (4)
|
|
90
|
+
- Editorial: every-style-editor (1)
|
|
91
|
+
|
|
92
|
+
## Key Constraint
|
|
93
|
+
|
|
94
|
+
Claude Code doesn't support plugin dependencies. Each plugin must be independent. Users manually install what they need, or we suggest additions via `/compound`.
|
|
95
|
+
|
|
96
|
+
## Acceptance Criteria
|
|
97
|
+
|
|
98
|
+
- [ ] Core plugin works standalone with universal agents
|
|
99
|
+
- [ ] `/compound` suggests agents based on detected tech stack
|
|
100
|
+
- [ ] Users can accept/decline suggestions
|
|
101
|
+
- [ ] `/agents` command for garden management
|
|
102
|
+
- [ ] No breaking changes for existing users
|
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
# Landing Page LaunchKit Refresh
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Review and enhance the `/docs/index.html` landing page using LaunchKit elements and Pragmatic Technical Writing style (Hunt/Thomas, Joel Spolsky). The current implementation is strong but can be refined section-by-section.
|
|
6
|
+
|
|
7
|
+
## Current State Assessment
|
|
8
|
+
|
|
9
|
+
### What's Working Well
|
|
10
|
+
- Specific, outcome-focused hero headline ("12 expert opinions in 30 seconds")
|
|
11
|
+
- Developer-authentic copywriting (N+1 queries, CORS, SQL injection)
|
|
12
|
+
- Stats section with clear metrics (23 agents, 16 commands, 11 skills, 2 MCP servers)
|
|
13
|
+
- Philosophy section with concrete story (N+1 query bug)
|
|
14
|
+
- Three-step installation with actual commands
|
|
15
|
+
- FAQ accordion following LaunchKit patterns
|
|
16
|
+
- Categorized feature sections with code examples
|
|
17
|
+
|
|
18
|
+
### Missing Elements (From Best Practices Research)
|
|
19
|
+
1. **Social Proof Section** - No testimonials, GitHub stars, or user metrics
|
|
20
|
+
2. **Visual Demo** - No GIF/animation showing the tool in action
|
|
21
|
+
3. **Arrow icons on CTAs** - 26% conversion boost from studies
|
|
22
|
+
4. **Trust indicators** - Open source badge, license info
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Section-by-Section Review Plan
|
|
27
|
+
|
|
28
|
+
### 1. Hero Section (lines 56-78)
|
|
29
|
+
|
|
30
|
+
**Current:**
|
|
31
|
+
```html
|
|
32
|
+
<h1>Your Code Reviews Just Got 12 Expert Opinions. In 30 Seconds.</h1>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Review Checklist:**
|
|
36
|
+
- [ ] Headline follows Pragmatic Writing (concrete before abstract) ✅
|
|
37
|
+
- [ ] Eyebrow badge is current (Version 2.6.0) - verify
|
|
38
|
+
- [ ] Description paragraph under 3 sentences ✅
|
|
39
|
+
- [ ] Button group has arrow icon on primary CTA
|
|
40
|
+
- [ ] "Read the Docs" secondary CTA present ✅
|
|
41
|
+
|
|
42
|
+
**Potential Improvements:**
|
|
43
|
+
- Add `→` arrow to "Install Plugin" button
|
|
44
|
+
- Consider adding animated terminal GIF below buttons showing `/review` in action
|
|
45
|
+
|
|
46
|
+
### 2. Stats Section (lines 81-104)
|
|
47
|
+
|
|
48
|
+
**Current:** 4 stat cards (23 agents, 16 commands, 11 skills, 2 MCP servers)
|
|
49
|
+
|
|
50
|
+
**Review Checklist:**
|
|
51
|
+
- [ ] Numbers are accurate (verify against actual file counts)
|
|
52
|
+
- [ ] Icons are appropriate for each stat
|
|
53
|
+
- [ ] Hover effects working properly
|
|
54
|
+
- [ ] Mobile layout (2x2 grid) is readable
|
|
55
|
+
|
|
56
|
+
**Potential Improvements:**
|
|
57
|
+
- Add "developers using" or "reviews run" metric if available
|
|
58
|
+
- Consider adding subtle animation on scroll
|
|
59
|
+
|
|
60
|
+
### 3. Philosophy Section (lines 107-192)
|
|
61
|
+
|
|
62
|
+
**Current:** "Why Your Third Code Review Should Be Easier Than Your First" with N+1 query story
|
|
63
|
+
|
|
64
|
+
**Review Checklist:**
|
|
65
|
+
- [ ] Opens with concrete story (N+1 query) ✅
|
|
66
|
+
- [ ] Quote block is memorable and quotable
|
|
67
|
+
- [ ] Four pillars (Plan, Delegate, Assess, Codify) are clear
|
|
68
|
+
- [ ] Each pillar has: tagline, description, tool tags
|
|
69
|
+
- [ ] Descriptions use "you" voice ✅
|
|
70
|
+
|
|
71
|
+
**Potential Improvements:**
|
|
72
|
+
- Review pillar descriptions for passive voice
|
|
73
|
+
- Ensure each pillar description follows PAS (Problem, Agitate, Solve) pattern
|
|
74
|
+
- Check tool tags are accurate and current
|
|
75
|
+
|
|
76
|
+
### 4. Agents Section (lines 195-423)
|
|
77
|
+
|
|
78
|
+
**Current:** 23 agents in 5 categories (Review, Research, Design, Workflow, Docs)
|
|
79
|
+
|
|
80
|
+
**Review Checklist:**
|
|
81
|
+
- [ ] All 23 agents are listed (count actual files)
|
|
82
|
+
- [ ] Categories are logical and scannable
|
|
83
|
+
- [ ] Each card has: name, badge, description, usage code
|
|
84
|
+
- [ ] Descriptions are conversational (not passive)
|
|
85
|
+
- [ ] Critical badges (Security, Data) stand out
|
|
86
|
+
|
|
87
|
+
**Potential Improvements:**
|
|
88
|
+
- Review agent descriptions against pragmatic writing checklist
|
|
89
|
+
- Ensure descriptions answer "when would I use this?"
|
|
90
|
+
- Add concrete scenarios to generic descriptions
|
|
91
|
+
|
|
92
|
+
### 5. Commands Section (lines 426-561)
|
|
93
|
+
|
|
94
|
+
**Current:** 16 commands in 2 categories (Workflow, Utility)
|
|
95
|
+
|
|
96
|
+
**Review Checklist:**
|
|
97
|
+
- [ ] All 16 commands are listed (count actual files)
|
|
98
|
+
- [ ] Core workflow commands are highlighted
|
|
99
|
+
- [ ] Descriptions are action-oriented
|
|
100
|
+
- [ ] Command names match actual implementation
|
|
101
|
+
|
|
102
|
+
**Potential Improvements:**
|
|
103
|
+
- Review command descriptions for passive voice
|
|
104
|
+
- Lead with outcomes, not features
|
|
105
|
+
- Add "saves you X minutes" framing where appropriate
|
|
106
|
+
|
|
107
|
+
### 6. Skills Section (lines 564-703)
|
|
108
|
+
|
|
109
|
+
**Current:** 11 skills in 3 categories (Development, Content/Workflow, Image Generation)
|
|
110
|
+
|
|
111
|
+
**Review Checklist:**
|
|
112
|
+
- [ ] All 11 skills are listed (count actual directories)
|
|
113
|
+
- [ ] Featured skill (gemini-imagegen) is properly highlighted
|
|
114
|
+
- [ ] API key requirement is clear
|
|
115
|
+
- [ ] Skill invocation syntax is correct
|
|
116
|
+
|
|
117
|
+
**Potential Improvements:**
|
|
118
|
+
- Review skill descriptions against pragmatic writing
|
|
119
|
+
- Ensure each skill answers "what problem does this solve?"
|
|
120
|
+
|
|
121
|
+
### 7. MCP Servers Section (lines 706-751)
|
|
122
|
+
|
|
123
|
+
**Current:** 2 MCP servers (Playwright, Context7)
|
|
124
|
+
|
|
125
|
+
**Review Checklist:**
|
|
126
|
+
- [ ] Tool lists are accurate
|
|
127
|
+
- [ ] Descriptions explain WHY not just WHAT
|
|
128
|
+
- [ ] Framework support list is current (100+)
|
|
129
|
+
|
|
130
|
+
**Potential Improvements:**
|
|
131
|
+
- Add concrete example of each server in action
|
|
132
|
+
- Consider before/after comparison
|
|
133
|
+
|
|
134
|
+
### 8. Installation Section (lines 754-798)
|
|
135
|
+
|
|
136
|
+
**Current:** "Three Commands. Zero Configuration." with 3 steps
|
|
137
|
+
|
|
138
|
+
**Review Checklist:**
|
|
139
|
+
- [ ] Commands are accurate and work
|
|
140
|
+
- [ ] Step 3 shows actual usage examples
|
|
141
|
+
- [ ] Timeline visual (vertical line) renders correctly
|
|
142
|
+
- [ ] Copy buttons work on code blocks
|
|
143
|
+
|
|
144
|
+
**Potential Improvements:**
|
|
145
|
+
- Add copy-to-clipboard functionality if missing
|
|
146
|
+
- Consider adding "What you'll see" output example
|
|
147
|
+
|
|
148
|
+
### 9. FAQ Section (lines 801-864)
|
|
149
|
+
|
|
150
|
+
**Current:** 5 questions in accordion format
|
|
151
|
+
|
|
152
|
+
**Review Checklist:**
|
|
153
|
+
- [ ] Questions address real objections
|
|
154
|
+
- [ ] Answers are conversational (use "you")
|
|
155
|
+
- [ ] Accordion expand/collapse works
|
|
156
|
+
- [ ] No passive voice in answers
|
|
157
|
+
|
|
158
|
+
**Potential Improvements:**
|
|
159
|
+
- Review for weasel words ("best practices suggest")
|
|
160
|
+
- Ensure answers are direct and actionable
|
|
161
|
+
|
|
162
|
+
### 10. CTA Section (lines 868-886)
|
|
163
|
+
|
|
164
|
+
**Current:** "Install Once. Compound Forever." with Install + GitHub buttons
|
|
165
|
+
|
|
166
|
+
**Review Checklist:**
|
|
167
|
+
- [ ] Badge is eye-catching ("Free & Open Source")
|
|
168
|
+
- [ ] Headline restates core value proposition
|
|
169
|
+
- [ ] Primary CTA has arrow icon ✅
|
|
170
|
+
- [ ] Trust line at bottom
|
|
171
|
+
|
|
172
|
+
**Potential Improvements:**
|
|
173
|
+
- Review trust line copy
|
|
174
|
+
- Consider adding social proof element
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## NEW: Social Proof Section (To Add)
|
|
179
|
+
|
|
180
|
+
**Position:** After Stats section, before Philosophy section
|
|
181
|
+
|
|
182
|
+
**Components:**
|
|
183
|
+
- GitHub stars counter (dynamic or static)
|
|
184
|
+
- "Trusted by X developers" metric
|
|
185
|
+
- 2-3 testimonial quotes (if available)
|
|
186
|
+
- Company logos (if applicable)
|
|
187
|
+
|
|
188
|
+
**LaunchKit Pattern:**
|
|
189
|
+
```html
|
|
190
|
+
<section class="social-proof-section">
|
|
191
|
+
<div class="heading centered">
|
|
192
|
+
<p class="paragraph m secondary">Trusted by developers at</p>
|
|
193
|
+
</div>
|
|
194
|
+
<div class="logo-grid">
|
|
195
|
+
<!-- Company logos or GitHub badge -->
|
|
196
|
+
</div>
|
|
197
|
+
</section>
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## Pragmatic Writing Style Checklist (Apply to ALL Copy)
|
|
203
|
+
|
|
204
|
+
### The Five Laws
|
|
205
|
+
1. **Concrete Before Abstract** - Story/example first, then principle
|
|
206
|
+
2. **Physical Analogies** - Import metaphors readers understand
|
|
207
|
+
3. **Conversational Register** - Use "you", contractions, asides
|
|
208
|
+
4. **Numbered Frameworks** - Create referenceable structures
|
|
209
|
+
5. **Humor as Architecture** - Mental anchors for dense content
|
|
210
|
+
|
|
211
|
+
### Anti-Patterns to Find and Fix
|
|
212
|
+
- [ ] "It is recommended that..." → "Do this:"
|
|
213
|
+
- [ ] "Best practices suggest..." → "Here's what works:"
|
|
214
|
+
- [ ] Passive voice → Active voice
|
|
215
|
+
- [ ] Abstract claims → Specific examples
|
|
216
|
+
- [ ] Walls of text → Scannable lists
|
|
217
|
+
|
|
218
|
+
### Quality Checklist (Per Section)
|
|
219
|
+
- [ ] Opens with concrete story or example?
|
|
220
|
+
- [ ] Can reader skim headers and get the arc?
|
|
221
|
+
- [ ] Uses "you" at least once?
|
|
222
|
+
- [ ] Clear action reader can take?
|
|
223
|
+
- [ ] Reads aloud like speech?
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
## Implementation Phases
|
|
228
|
+
|
|
229
|
+
### Phase 1: Copy Audit (No HTML Changes)
|
|
230
|
+
1. Read through entire page
|
|
231
|
+
2. Flag passive voice instances
|
|
232
|
+
3. Flag abstract claims without examples
|
|
233
|
+
4. Flag missing "you" voice
|
|
234
|
+
5. Document improvements needed
|
|
235
|
+
|
|
236
|
+
### Phase 2: Copy Rewrites
|
|
237
|
+
1. Rewrite flagged sections following pragmatic style
|
|
238
|
+
2. Ensure each section passes quality checklist
|
|
239
|
+
3. Maintain existing HTML structure
|
|
240
|
+
|
|
241
|
+
### Phase 3: Component Additions
|
|
242
|
+
1. Add arrow icons to primary CTAs
|
|
243
|
+
2. Add social proof section (if data available)
|
|
244
|
+
3. Consider visual demo element
|
|
245
|
+
|
|
246
|
+
### Phase 4: Verification
|
|
247
|
+
1. Validate all counts (agents, commands, skills)
|
|
248
|
+
2. Test all links and buttons
|
|
249
|
+
3. Verify mobile responsiveness
|
|
250
|
+
4. Check accessibility
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
## Files to Modify
|
|
255
|
+
|
|
256
|
+
| File | Changes |
|
|
257
|
+
|------|---------|
|
|
258
|
+
| `docs/index.html` | Copy rewrites, potential new section |
|
|
259
|
+
| `docs/css/style.css` | Social proof styles (if adding) |
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## Success Criteria
|
|
264
|
+
|
|
265
|
+
1. All copy passes Pragmatic Writing quality checklist
|
|
266
|
+
2. No passive voice in any description
|
|
267
|
+
3. Every feature section answers "why should I care?"
|
|
268
|
+
4. Stats are accurate against actual file counts
|
|
269
|
+
5. Page loads in <3 seconds
|
|
270
|
+
6. Mobile layout is fully functional
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
## References
|
|
275
|
+
|
|
276
|
+
- LaunchKit Template: https://launchkit.evilmartians.io/
|
|
277
|
+
- Pragmatic Writing Skill: `~/.claude/skills/pragmatic-writing-skill/SKILL.md`
|
|
278
|
+
- Current Landing Page: `/Users/kieranklaassen/every-marketplace/docs/index.html`
|
|
279
|
+
- Style CSS: `/Users/kieranklaassen/every-marketplace/docs/css/style.css`
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "coding-tutor",
|
|
3
|
+
"version": "1.2.1",
|
|
4
|
+
"description": "Personalized coding tutorials that use your actual codebase for examples with spaced repetition quizzes",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Nityesh Agarwal"
|
|
7
|
+
},
|
|
8
|
+
"keywords": ["coding", "programming", "tutorial", "learning", "spaced-repetition"]
|
|
9
|
+
}
|