Skip to content

docs: add agent skills for AI coding agents - #255

Merged
dangreen merged 1 commit into
mainfrom
docs/agent-skills
Sep 9, 2026
Merged

docs: add agent skills for AI coding agents#255
dangreen merged 1 commit into
mainfrom
docs/agent-skills

Conversation

@dangreen

@dangreen dangreen commented Sep 9, 2026

Copy link
Copy Markdown
Member

Why

AI coding agents working on a Nano Kit app need the API of the released packages and the conventions around it. Pasting the documentation into the skills duplicated the site and drifted from it, and pointing agents at the llms.txt sets pulled in the whole site with articles, anchors and images. A skill now carries only guidance, and the documentation next to it is generated from the same sources the site is built from.

What

  • skills/nano-kit-{store,query,intl,platform-web,react,react-router,react-ssr}: SKILL.md with conventions, choices and pitfalls (the store skill marks the low-level APIs as territory for adapters, bindings and tests), plus a generated DOCS.md with the released documentation. Installed with pnpx skills add TrigenSoftware/nano_kit --skill <name>.
  • scripts/skills-docs: a private workspace package with the skills-docs CLI. It parses the MDX sources with remark, keeps the tabs a skill prefers (metadata.docs.tabs plus --tabs), converts the Starlight components (Tabs, Code, Aside, Steps, Card) to plain Markdown, unwraps internal links to text unless --site is given, drops the sections named in --drop, and fails with --check when a DOCS.md is stale. The pages of a skill come from metadata.docs.paths in its frontmatter. pnpm skills:docs runs it with the repo settings.
  • Site: an Agent Skills page in Getting Started (Introduction pinned first), and articles/** excluded from llms-small.txt.
  • README: an Agent Skills section with the list of skills and the install command.
  • packages/kida/README.md: the example uses the for_ name.
  • pnpm-workspace.yaml adds scripts/*. The lockfile diff also carries pnpm 10.33 re-normalising peer suffixes and linkDirectory entries written by earlier Renovate updates.

Not included: CI does not run pnpm skills:docs --check yet.

Checks

  • pnpm skills:docs --check passes, all seven DOCS.md are current.
  • oxlint scripts/skills-docs passes.
  • pnpm install --frozen-lockfile passes.
  • astro build of the website passes, 62 pages.

@codecov

codecov Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.33%. Comparing base (fb4365f) to head (e9b92be).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #255   +/-   ##
=======================================
  Coverage   83.33%   83.33%           
=======================================
  Files          98       98           
  Lines        2557     2557           
  Branches      552      552           
=======================================
  Hits         2131     2131           
  Misses        314      314           
  Partials      112      112           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Seven skills in `skills/`, one per package: a guidance-only `SKILL.md` with conventions, choices and pitfalls, and a generated `DOCS.md` with the released documentation of the package. The `skills-docs` workspace script in `scripts/skills-docs` builds `DOCS.md` from the site sources through the MDX AST, keeps the tabs a skill prefers, drops the sections listed in `--drop`, and verifies the files with `--check` (`pnpm skills:docs`). The Getting Started section of the site gets an Agent Skills page and the README a skills list. `articles/**` are excluded from `llms-small.txt`, and the `kida` README uses the `for_` name.
@dangreen
dangreen merged commit 39ebdc0 into main Sep 9, 2026
10 checks passed
@dangreen
dangreen deleted the docs/agent-skills branch September 9, 2026 15:06
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.

1 participant