chore(kyberforge): move research docs under docs/research/ and update README

Separates development-time reference material from live plugin docs.
agentskillsio/, agentsmd/, and examples/skill-write/ are not shipped with
the plugin — grouping them under research/ makes that boundary explicit.
README now lists all top-level files and explains what research/ is for.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-06-23 17:18:20 +00:00
parent 2777a834b2
commit 5ff78fc146
50 changed files with 24 additions and 11 deletions

View File

@@ -1,7 +1,20 @@
# docs/
Plugin documentation. Place usage guides, reference material, and examples here.
Plugin documentation. Not read automatically by Claude Code or GitHub Copilot CLI — reference specific files from skill bodies or agent prompts as needed.
This directory is not read automatically by either Claude Code or GitHub Copilot CLI.
Reference specific files from your skill bodies or agent prompts when needed
(e.g. `See references/usage.md for examples`).
## Files
| Path | Purpose |
|------|---------|
| `plugin-marketplace-architecture.md` | Claude Code vs Copilot CLI divergence, two-manifest pattern, plugin constraints, cross-tool compatibility |
| `adding-agents.md` | How to add agent definitions to the kyberforge plugin |
## research/
Upstream reference material gathered during skill authoring. Not shipped with the plugin — used at development time only.
| Path | Purpose |
|------|---------|
| `research/docs/agentskillsio/` | agentskills.io spec, skill authoring, description optimization, eval design, scripts |
| `research/docs/agentsmd/` | agents.md format spec and cross-tool configuration reference |
| `research/examples/skill-write/` | Upstream skill examples reviewed when authoring skill-write and skill-audit |

View File

@@ -4,49 +4,49 @@
- **URL:** https://agentskills.io/home.md
- **Description:** Agent Skills overview — what it is, why it exists, progressive disclosure model, ecosystem of 35+ implementing tools
- **Contributing files:** agentskills-overview.md
- **Contributing files:** overview.md
- **Status:** `extracted`
## agentskills-spec
- **URL:** https://agentskills.io/specification.md
- **Description:** Complete SKILL.md format specification — frontmatter fields, constraints, body content, optional directories, progressive disclosure levels, file references, validation
- **Contributing files:** agentskills-overview.md, agentskills-specification.md, agentskills-examples.md
- **Contributing files:** overview.md, specification.md, examples.md
- **Status:** `extracted`
## agentskills-best-practices
- **URL:** https://agentskills.io/skill-creation/best-practices.md
- **Description:** Best practices for skill creators — starting from real expertise, spending context wisely, calibrating control, instruction patterns (gotchas, templates, checklists, validation loops)
- **Contributing files:** agentskills-skill-authoring.md, agentskills-examples.md
- **Contributing files:** skill-authoring.md, examples.md
- **Status:** `extracted`
## agentskills-optimizing-descriptions
- **URL:** https://agentskills.io/skill-creation/optimizing-descriptions.md
- **Description:** How to systematically test and improve skill descriptions for triggering accuracy — eval queries, trigger rate testing, train/validation splits, optimization loop
- **Contributing files:** agentskills-optimizing-descriptions.md, agentskills-examples.md
- **Contributing files:** optimizing-descriptions.md, examples.md
- **Status:** `extracted`
## agentskills-evaluating-skills
- **URL:** https://agentskills.io/skill-creation/evaluating-skills.md
- **Description:** Eval-driven skill quality improvement — test case design, workspace structure, assertion writing, grading, benchmarking, human review, iteration loop
- **Contributing files:** agentskills-evaluating-skills.md, agentskills-examples.md
- **Contributing files:** evaluating-skills.md, examples.md
- **Status:** `extracted`
## agentskills-using-scripts
- **URL:** https://agentskills.io/skill-creation/using-scripts.md
- **Description:** Using scripts in skills — one-off commands, self-contained scripts with inline dependencies, designing scripts for agentic use (no interactive prompts, --help, structured output, idempotency)
- **Contributing files:** agentskills-scripts.md
- **Contributing files:** scripts.md
- **Status:** `extracted`
## agentskills-quickstart
- **URL:** https://agentskills.io/skill-creation/quickstart.md
- **Description:** Step-by-step guide to creating a first skill (roll-dice example), how discovery/activation/execution work in practice
- **Contributing files:** agentskills-overview.md, agentskills-examples.md
- **Contributing files:** overview.md, examples.md
- **Status:** `extracted`
## agentskills-llms-txt