Skip to content

refactor: unified spec, skills, and workflow organization#1488

Draft
jsell-rh wants to merge 18 commits intomainfrom
spec-organization
Draft

refactor: unified spec, skills, and workflow organization#1488
jsell-rh wants to merge 18 commits intomainfrom
spec-organization

Conversation

@jsell-rh
Copy link
Copy Markdown
Contributor

@jsell-rh jsell-rh commented Apr 30, 2026

Summary

Implements #1478 — unified location, format, and conventions for specs, skills, and workflows.

Three top-level directories

  • specs/ — desired state of the system, organized by capability domain (sessions, agents, control-plane, integrations) with cross-cutting standards under specs/standards/
  • skills/ — Agent Skills (agentskills.io), domain-nested with cross-cutting skills flat at root
  • workflows/ — agent-consumable procedures, domain-nested

Projections (symlinks)

  • .claude/skills -> ../skills — Claude Code discovers top-level (cross-cutting) skills
  • .agents/skills -> ../skills — agentskills.io standard projection
  • .agents/workflows -> ../workflows — agentskills.io standard projection
  • specs/{domain}/.agents/skills -> ../../../skills/{domain} — domain-specific skill storage
  • specs/{domain}/.claude/skills -> ../.agents/skills — Claude Code discovers domain skills in context

New content

  • specs/index.spec.md — spec ethos, RFC 2119 format with Given/When/Then scenarios, organization conventions
  • /discover skill — mandatory first step for all coding/spec work; walks through domain discovery
  • /spec skill — guides spec creation following the project format and 8-phase spec-change workflow
  • spec-change.workflow.md — 8-phase process: frame, ground in codebase, draft, critic pass, synthesize, design questions, apply fixes, second critic pass

What moved

From To
docs/internal/design/*.spec.md specs/{domain}/
docs/internal/design/*.guide.md workflows/{domain}/*.workflow.md
Component DEVELOPMENT.md, *_PATTERNS.md specs/standards/{domain}/
docs/security-standards.md specs/standards/security/security.spec.md
docs/coderabbit-derived-conventions.md specs/standards/platform/cross-cutting.spec.md
.claude/skills/* skills/ (with domain nesting)

Deleted

  • Ephemeral artifacts (plan.md, tasks.md, research.md, quickstart.md, checklists/) from numbered spec dirs

Test plan

  • Verify .claude/skills/ symlink resolves and Claude Code discovers top-level skills
  • Verify specs/{domain}/.claude/skills symlinks resolve to domain-specific skills
  • Verify all agent definitions reference valid paths
  • Verify no stale references to old paths remain
  • Run /discover and /spec skills to confirm they work end-to-end

Closes #1478

jsell-rh and others added 16 commits April 30, 2026 15:12
Move *.spec.md files from docs/internal/design/ into capability domain
directories under specs/: sessions/, control-plane/, integrations/, agents/.

Update all cross-references in devflow skill, guide files, and within
the moved specs themselves. Historical metrics data in
scripts/coderabbit-triage/ intentionally left unchanged.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move conventions, patterns, and standards files into domain-organized
directories under specs/standards/:
- backend/ — conventions, error handling, K8s client patterns
- frontend/ — conventions, React Query patterns
- control-plane/ — operator conventions
- security/ — security standards
- platform/ — cross-cutting conventions (CodeRabbit-derived)

Update all references in agent definitions, amber-review skill,
CLAUDE.md, and BOOKMARKS.md.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Rename *.guide.md to *.workflow.md and move from docs/internal/design/
to workflows/{domain}/:
- sessions/ambient-model.workflow.md
- control-plane/control-plane.workflow.md
- integrations/mcp-server.workflow.md

Fix pre-existing broken reference to ambient-data-model.md. Update
cross-references in devflow skill, manifests README, and design README.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move .claude/skills/ to top-level skills/ directory with capability
domain organization:
- Cross-cutting skills flat at root: devflow, align, amber-review,
  scaffold, memory, pr-fixer
- Domain-nested: sessions/, control-plane/, frontend/, integrations/

Create .claude/skills symlink → ../skills/ for Claude Code discovery.
Update convention-guard.sh to match both paths. Fix pre-existing
broken .claude/context/ references in devflow skill.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Delete plan.md, tasks.md, research.md, quickstart.md, and checklists/
from numbered spec directories. These are stale development artifacts
that don't belong alongside specs (desired state descriptions).

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add specs/, workflows/, skills/ to CLAUDE.md structure section. Update
BOOKMARKS.md with new Specs, Workflows, and Standards sections replacing
the old Component Development Guides and Cross-Cutting Conventions
sections. Fix stale .claude/patterns/ and .claude/context/ references.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move skills/ and workflows/ under .agents/ to follow the agentskills.io
convention:
- .agents/skills/ — domain-nested storage (sessions/, control-plane/,
  frontend/, integrations/) with cross-cutting skills flat at root
- .agents/workflows/ — domain-nested agent procedures
- .claude/skills symlinks to .agents/skills/ for Claude Code discovery
  (top-level only: cross-cutting skills)
- specs/{domain}/.agents/skills symlinks to .agents/skills/{domain}/
  for domain-scoped skill discovery

Update all references across CLAUDE.md, BOOKMARKS.md, devflow skill,
convention guard, spec files, design docs, and workflow files.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add .claude/skills symlinks alongside .agents/skills in each spec
domain directory so Claude Code discovers domain-specific skills
when working within a domain context.

Chain: specs/{domain}/.claude/skills -> ../.agents/skills ->
       ../../../.agents/skills/{domain}

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Mandatory first step for all coding and spec work. The skill walks
agents through identifying relevant capability domains, cd'ing into
specs/{domain}/ to discover domain-specific skills via .claude/skills
symlinks, loading relevant specs, and checking applicable standards.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Establishes the principles, format, and organization conventions for
specs: desired state (not issue tracking), living documents (amended or
deleted, never archived), behavior contracts with RFC 2119 keywords,
and Given/When/Then scenarios.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Guides agents through creating specs that follow the project's format
and conventions. Requires reading specs/index.spec.md before proceeding,
enforces behavior-contract focus over implementation details, and walks
through domain identification, context discovery, and RFC 2119 usage.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add brevity instruction to discover skill output. Clarify that
implementation invariants (not plans) may appear in specs, and remove
redundant "execution plans" bullet from the avoid list.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add .agents/workflows/specs/spec-change.workflow.md defining the full
7-phase spec change process: frame, draft, critic pass, synthesize,
design questions, apply fixes, second critic pass.

Update spec skill to require reading both specs/index.spec.md and the
workflow before proceeding, and restructure steps to follow the
workflow phases.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Insert a codebase grounding phase between framing and drafting. The
agent reads existing specs and code in affected areas, summarizes its
understanding back to the user in 3-5 sentences, and only asks
questions where the codebase is genuinely ambiguous. Saves the user
from answering things the agent can verify itself.

Renumber subsequent phases (now 8 total). Update spec skill to match.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 30, 2026

Deploy Preview for cheerful-kitten-f556a0 ready!

Name Link
🔨 Latest commit 2ad55ac
🔍 Latest deploy log https://app.netlify.com/projects/cheerful-kitten-f556a0/deploys/69f4c5810c424a0008db053d
😎 Deploy Preview https://deploy-preview-1488--cheerful-kitten-f556a0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 30, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 7fae8d7d-4610-4636-9a86-ac195eba597c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch spec-organization
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch spec-organization

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

jsell-rh and others added 2 commits May 1, 2026 11:22
Move canonical storage from .agents/ to top-level directories:
- skills/ — canonical home for all agent skills
- workflows/ — canonical home for all agent workflows
- .agents/skills and .agents/workflows become symlinks (projection)
- .claude/skills points directly to skills/

Update all references across CLAUDE.md, BOOKMARKS.md, skill files,
spec files, workflow files, design docs, and convention guard.

Part of #1478

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

proposal: unified spec location, format, and update workflow

1 participant