{{ message }}
Repository navigation
[TASK] Add agent docs and Claude Code skills - #4289
Open
seahindeniz wants to merge 1 commit into
Open
seahindeniz wants to merge 1 commit into
seahindeniz wants to merge 1 commit into
Conversation
- AGENTS.md (root): commands, architecture and conventions for any coding agent; CLAUDE.md imports it, following the existing src/pages-chibi convention. - CLAUDE.md: project skill index, a self-maintenance rule that keeps agent docs and skills current in every PR, and skill authoring rules. - .claude/skills/writing-chibi-integrations: workflows (new, fix, review) and reference on ChibiScript runtime semantics, lifecycle and engine internals, page options, headless test comparison and the ChibiDev API. Builds on src/pages-chibi/AGENTS.md instead of repeating it. - .claude/skills/running-malsync-locally: setup, dev loop incl. the chibi CLI, CI parity, npm scripts, build outputs, testing and troubleshooting. - src/pages-chibi/AGENTS.md: node/npm requirement updated to match package.json. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Adds agent documentation at the repo root and two Claude Code skills. They build on the existing
src/pages-chibi/AGENTS.mdand don't repeat it.AGENTS.md(root): commands, architecture and conventions for any coding agent.CLAUDE.mdimports it with@AGENTS.md, the same convention assrc/pages-chibi/andsrc/pages/.CLAUDE.md(root):.claude/skills/writing-chibi-integrations/:requestProxy,customDomains,urls.player,computedType,readerConfig,minimumVersion), engine internals, howtest:headlesscompares each field, and the fullChibiDevAPI..claude/skills/running-malsync-locally/:npm run chibiand the MCP port), and reproducing each CI job locally;src/pages-chibi/AGENTS.md: the node/npm requirement now matchespackage.json(>= 24 / >= 11 instead of 22.12 / 8).Why skills in the root
.claude/skills/src/pages-chibi/AGENTS.mdis the right place for page-author rules, but it loads only when an agent works insidesrc/pages-chibi/, and it has to stay short. Plenty of work starts elsewhere: a user pastes a site URL, a test fails in CI, the build breaks on Windows, a reviewer looks at a chibi PR. Some knowledge also doesn't fit a rules file, such as why a chain returned0, howtrigger()resets state, or which fields the headless runner compares.Skills in the root
.claude/skills/solve this:SKILL.mdis a short router (~40 lines). A task table lists exactly which files to read for each task, always starting with the relevantAGENTS.md, so related information isn't missed. The details live in single-topic files under 75 lines each. An agent fixing a page reads the fixing workflow, runtime semantics and lifecycle, not the CI or engine docs. This follows Anthropic's skill-authoring guidance:SKILL.mdwell under 500 lines, references one level deep, one topic per file. It also keeps the hub well within the first 5,000 tokens of each skill, which is what Claude Code keeps after context compaction.AGENTS.mdstays authoritative for rules and conventions, and the generatedsrc/chibiScript/FUNCTIONS.mdstays the function reference. The skills route to them and add only what they don't cover. If they disagree, the code andAGENTS.mdwin.Self-maintenance
CLAUDE.mdtells Claude to check, in every commit or PR it creates or updates (including PRs unrelated to agent docs), whether the change makes anything inCLAUDE.md, anAGENTS.mdor a skill outdated. If it does, Claude fixes it in the same PR. A "Sources it documents" column maps code paths to skills, so the check is mechanical. This PR applies the rule once: thesrc/pages-chibi/AGENTS.mdversion fix.Verification
master. Function names were checked against a freshly generatedFUNCTIONS.md. Build-only outputs (dist/…,test/dist/…) were checked against the webpack configs and CLI source.ChibiParamresolution,and/orvalues, lifecycle, loader merge, headless comparison) were checked againstChibiConsumer.ts,ChibiCtx.ts,ChibiProxy.ts,ChibiListRepository.ts,test/headless/test.jsandtest/chibiDev/runtime.ts.🤖 Generated with Claude Code