Skip to content

docs: add agentic context layer and skill registry#22

Merged
tiero merged 2 commits intoarkade-os:masterfrom
AbdelStark:chore/agentic-context-layer
Mar 2, 2026
Merged

docs: add agentic context layer and skill registry#22
tiero merged 2 commits intoarkade-os:masterfrom
AbdelStark:chore/agentic-context-layer

Conversation

@AbdelStark
Copy link
Copy Markdown
Contributor

@AbdelStark AbdelStark commented Mar 2, 2026

Summary

  • replace CLAUDE.md with a machine-first context spec aligned to the current Rust/compiler/playground layout
  • add agents.md with explicit multi-agent delegation, state machine, and escalation protocol
  • add canonical skills registry and project-specific skills under .codex/skills/
  • add compatibility symlink .agents/skills -> ../.codex/skills
  • retain .claude ignore behavior and add clarifying comments in .gitignore

Validation

  • cargo fmt --check
  • cargo test

Scope

  • documentation/context infrastructure only (no runtime/compiler logic changes)

Summary by CodeRabbit

  • Documentation

    • Added a centralized skills registry and comprehensive guides for compiler debugging, language-feature development, regression testing, and WASM playground workflows
    • Restructured and expanded main project documentation for clearer navigation and guidance
    • Introduced a formal multi-role collaboration and task-management protocol
  • Chores

    • Updated ignore rules to reflect tracking of canonical skills and compatibility symlinks

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db60601 and 39c438b.

📒 Files selected for processing (4)
  • .claude/skills
  • .codex/skills/_index.md
  • .gitignore
  • agents.md
✅ Files skipped from review due to trivial changes (1)
  • .claude/skills
🚧 Files skipped from review as they are similar to previous changes (3)
  • agents.md
  • .codex/skills/_index.md
  • .gitignore

Walkthrough

Adds a central Skill Registry and multiple new procedural docs under .codex/skills/, restructures CLAUDE.md, introduces agents.md for collaboration protocol, and adds small symlink/reference files plus a .gitignore tweak. No code or public API changes.

Changes

Cohort / File(s) Summary
Skill Registry & Guides
.codex/skills/_index.md, .codex/skills/compiler-debugging.md, .codex/skills/language-feature-development.md, .codex/skills/testing-and-regressions.md, .codex/skills/wasm-playground-workflow.md
Add a central index and five detailed workflow/skill documents (compiler debugging, language feature development, testing/regressions, WASM playground). Focus: procedures, checklists, examples, troubleshooting, and references. Reviewers should verify accuracy of referenced paths and procedural steps.
Project Documentation
CLAUDE.md, agents.md
Replace and restructure main project documentation (CLAUDE.md) and add agents.md describing roles, delegation protocol, task lifecycle, and escalation policies. Confirm new conventions and workflow descriptions align with existing processes.
Tooling / Compatibility References
.claude/skills, .agents/skills, .gitignore
Add small files pointing to .codex/skills (symlink/compatibility references) and adjust .gitignore entries/comments. Check that tracked symlink paths match repository layout and ignore rules are correct.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the primary change: adding an agentic context layer (agents.md) and a skill registry (.codex/skills/) with supporting documentation infrastructure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (2)
.gitignore (1)

36-38: Use neutral, directive comments in .gitignore instead of conversational guidance.

At Line 36 through Line 38, the wording reads like an inline debate and can confuse maintainers about intended policy.

Suggested comment cleanup
-# I would suggest removing this to explicitly enable putting .claude skills and plugin in the repo
-# Note: with my PR, it will effectively still work because .codex/skills is used as source of truth
-# with multiple symlinks to it for compatibility with other harness tools.
+# Keep `.claude` ignored by default.
+# Canonical skills are stored in `.codex/skills`; compatibility links can be maintained separately if tracked.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.gitignore around lines 36 - 38, Replace the conversational/debate-style
comment referencing ".claude skills and plugin" and ".codex/skills" with a
concise, neutral directive that states the intended policy; e.g. remove phrases
like "I would suggest" and "Note: with my PR" and instead write a single-line
instruction such as whether .claude skills and plugins should be committed or
ignored and which path (e.g., .codex/skills) is the canonical source, keeping
the comment short and declarative to clarify maintainers' intent.
.codex/skills/_index.md (1)

7-10: Consider making skill files clickable in the registry table.

Using markdown links in the File column improves navigation with no behavioral risk.

🔗 Suggested usability tweak
-| Language Feature Development | language-feature-development.md | grammar, parser, syntax, AST, opcode, new expression, new requirement | Core |
-| Testing and Regressions | testing-and-regressions.md | test, regression, fixture, assertion, CLI parity, coverage | Core |
-| WASM Playground Workflow | wasm-playground-workflow.md | playground, wasm-pack, contracts.js, github pages, browser demo | Core |
-| Compiler Debugging | compiler-debugging.md | parse error, asm mismatch, compile failure, introspection fallback | Core |
+| Language Feature Development | [language-feature-development.md](./language-feature-development.md) | grammar, parser, syntax, AST, opcode, new expression, new requirement | Core |
+| Testing and Regressions | [testing-and-regressions.md](./testing-and-regressions.md) | test, regression, fixture, assertion, CLI parity, coverage | Core |
+| WASM Playground Workflow | [wasm-playground-workflow.md](./wasm-playground-workflow.md) | playground, wasm-pack, contracts.js, GitHub Pages, browser demo | Core |
+| Compiler Debugging | [compiler-debugging.md](./compiler-debugging.md) | parse error, asm mismatch, compile failure, introspection fallback | Core |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.codex/skills/_index.md around lines 7 - 10, Convert the plain filenames in
the registry table's "File" column into markdown links so each skill row becomes
clickable; specifically replace entries like language-feature-development.md,
testing-and-regressions.md, wasm-playground-workflow.md, and
compiler-debugging.md with markdown link syntax
[language-feature-development.md](language-feature-development.md) etc., keeping
the display text the same and preserving the existing table structure and tags
so only the File column values change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.codex/skills/_index.md:
- Line 9: Update the product-name capitalization in the table row containing
"WASM Playground Workflow" so the third column uses the official form "GitHub
Pages" instead of "github pages"; locate the row text matching "WASM Playground
Workflow | wasm-playground-workflow.md | playground, wasm-pack, contracts.js,
github pages, browser demo | Core" and replace that token only to "GitHub
Pages".

In @.gitignore:
- Line 39: The .gitignore contains an entry ".claude" which prevents tracking
the .claude/skills symlink; remove the ".claude" ignore pattern so
.claude/skills can be committed (matching the existing tracked .agents/skills
symlink behavior). Edit the .gitignore to delete the ".claude" line (and ensure
any comment about enabling .claude skills/plugins remains consistent) so that
the .claude/skills symlink and related files can be added to version control.

In `@agents.md`:
- Line 62: Replace the ambiguous phrase "BLOCKED requires: blocker, attempts,
and required input." with explicit plural wording; update the sentence to read
"BLOCKED requires: blocker, attempts, and required inputs." so the requirement
is clearly plural and unambiguous (locate the line containing the literal phrase
"BLOCKED requires: blocker, attempts, and required input.").

---

Nitpick comments:
In @.codex/skills/_index.md:
- Around line 7-10: Convert the plain filenames in the registry table's "File"
column into markdown links so each skill row becomes clickable; specifically
replace entries like language-feature-development.md,
testing-and-regressions.md, wasm-playground-workflow.md, and
compiler-debugging.md with markdown link syntax
[language-feature-development.md](language-feature-development.md) etc., keeping
the display text the same and preserving the existing table structure and tags
so only the File column values change.

In @.gitignore:
- Around line 36-38: Replace the conversational/debate-style comment referencing
".claude skills and plugin" and ".codex/skills" with a concise, neutral
directive that states the intended policy; e.g. remove phrases like "I would
suggest" and "Note: with my PR" and instead write a single-line instruction such
as whether .claude skills and plugins should be committed or ignored and which
path (e.g., .codex/skills) is the canonical source, keeping the comment short
and declarative to clarify maintainers' intent.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63ceb96 and db60601.

📒 Files selected for processing (9)
  • .agents/skills
  • .codex/skills/_index.md
  • .codex/skills/compiler-debugging.md
  • .codex/skills/language-feature-development.md
  • .codex/skills/testing-and-regressions.md
  • .codex/skills/wasm-playground-workflow.md
  • .gitignore
  • CLAUDE.md
  • agents.md

@AbdelStark
Copy link
Copy Markdown
Contributor Author

AbdelStark commented Mar 2, 2026

Addressed CodeRabbit feedback in commit 39c438b.

  • .gitignore: replaced conversational note with neutral policy text.
  • .gitignore: removed .claude ignore entry and added tracked .claude/skills symlink.
  • .codex/skills/_index.md: made skill file names clickable links.
  • .codex/skills/_index.md: corrected GitHub Pages capitalization.
  • agents.md: changed "required input" to "required inputs".

Validation rerun: cargo fmt --check.

@tiero tiero merged commit 20ce692 into arkade-os:master Mar 2, 2026
3 checks passed
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.

2 participants