Skip to content

Commit da5b594

Browse files
authored
docs: update docs to reflect Skills Discovery RFC changes from #65 (#68)
Replace stale references to `.well-known/agent.json` and `/skills/{name}.md` with the new `.well-known/skills/` endpoints. Also rename ApiTab → AccessTab in project structure, and add agent-first writing callout to CONTRIBUTING.md.
1 parent 846a507 commit da5b594

3 files changed

Lines changed: 9 additions & 8 deletions

File tree

.claude/CLAUDE.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains agent-readable skill files for the Internet Computer. E
44

55
## Key Rules
66

7-
- **`llms.txt`, `llms-full.txt`, `.well-known/agent.json`, and `sitemap.xml`** are all generated by Astro at build time into `dist/`. They are NOT committed to git.
7+
- **`llms.txt`, `llms-full.txt`, `.well-known/skills/`, and `sitemap.xml`** are all generated by Astro at build time into `dist/`. They are NOT committed to git.
88
- **Never edit Astro source files to add or update a skill** — the website auto-discovers skills from SKILL.md frontmatter at build time. Only edit `src/` files for site-level UI changes.
99
- **One skill = one file** at `skills/<skill-name>/SKILL.md`. No nested directories, no images, no external dependencies within a skill.
1010
- Skill names are **lowercase, hyphenated** (e.g., `ckbtc`, `https-outcalls`, `stable-memory`) and must match the directory name. This aligns with the [Agent Skills spec](https://agentskills.io/specification).
@@ -72,16 +72,15 @@ src/ # Astro site source
7272
layouts/BaseLayout.astro # HTML shell, meta tags, JSON-LD
7373
layouts/SiteLayout.astro # Shared header/nav/footer for main pages
7474
components/BrowseTab.tsx # Preact island: search + skill grid
75-
components/ApiTab.tsx # Preact island: access/endpoints reference
75+
components/AccessTab.tsx # Preact island: access/endpoints reference
7676
components/SkillHeader.tsx # Preact island: skill detail header
7777
pages/index.astro # Browse page
7878
pages/how-it-works/ # How it works page (fully static)
7979
pages/access/ # Access reference page (real endpoints)
8080
pages/skills/[slug]/ # Dynamic skill pages (pre-rendered)
81-
pages/skills/[slug].md.ts # Raw .md endpoint per skill
8281
pages/llms.txt.ts # Skills index for agents
8382
pages/llms-full.txt.ts # All skills concatenated
84-
pages/.well-known/ # Agent discovery manifests
83+
pages/.well-known/skills/ # Skills Discovery RFC endpoints (index.json + per-skill SKILL.md)
8584
public/ # Static assets (favicon, etc.)
8685
astro.config.mjs # Astro configuration
8786
```

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ npm ci # Install dependencies
2222

2323
## Adding a New Skill
2424

25+
> **Skills are written for AI agents, not humans.** Every decision — structure, wording, level of detail — should optimize for machine consumption. Be explicit and literal: exact canister IDs, exact function signatures, exact error strings. Do not summarize, hand-wave, or link out when you can inline the information. An agent cannot click a link or interpret vague guidance.
26+
2527
### 1. Create the skill directory
2628

2729
```
@@ -123,7 +125,7 @@ This runs automatically in CI and blocks deployment on errors.
123125

124126
### 4. That's it — the website auto-discovers skills
125127

126-
The website is automatically generated from the SKILL.md frontmatter at build time. You do **not** need to edit any source file. Astro reads all `skills/*/SKILL.md` files, parses their frontmatter, and generates the site pages, `llms.txt`, `agent.json`, and other discovery files.
128+
The website is automatically generated from the SKILL.md frontmatter at build time. You do **not** need to edit any source file. Astro reads all `skills/*/SKILL.md` files, parses their frontmatter, and generates the site pages, `llms.txt`, discovery endpoints, and other files.
127129

128130
Stats (skill count, categories) all update automatically.
129131

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ The files are plain markdown — paste into any system prompt, rules file, or co
6969
| Skill index | [`llms.txt`](https://dfinity.github.io/icskills/llms.txt) | Short index with links to each skill |
7070
| All skills | [`llms-full.txt`](https://dfinity.github.io/icskills/llms-full.txt) | All skills concatenated for direct context injection |
7171
| Single skill | `https://raw.githubusercontent.com/dfinity/icskills/main/skills/{name}/SKILL.md` | Raw markdown for one skill |
72-
| Agent discovery | [`.well-known/agent.json`](https://dfinity.github.io/icskills/.well-known/agent.json) | Machine-readable skill manifest |
72+
| Skills discovery | [`.well-known/skills/index.json`](https://dfinity.github.io/icskills/.well-known/skills/index.json) | Machine-readable skill index ([Cloudflare Skills Discovery RFC](https://github.com/cloudflare/agent-skills-discovery-rfc)) |
73+
| Single skill (API) | `/.well-known/skills/{name}/SKILL.md` | Raw markdown via discovery endpoint |
7374
| Skill page (HTML) | [`/skills/{name}/`](https://dfinity.github.io/icskills/skills/ckbtc/) | Pre-rendered skill page with full SEO |
74-
| Skill page (MD) | [`/skills/{name}.md`](https://dfinity.github.io/icskills/skills/ckbtc.md) | Raw markdown served with `text/markdown` content type |
7575
| CLI | `npx skills add dfinity/icskills` | Browse and install skills via [skills.sh](https://skills.sh) |
7676

7777
## Contributing
@@ -88,7 +88,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add or update skills.
8888
- **Validation**: Structural linter for frontmatter and code blocks (`npm run validate`)
8989
- **Schema**: JSON Schema for frontmatter at `skills/skill.schema.json`
9090
- **SEO**: Per-skill meta tags, JSON-LD (TechArticle), sitemap, canonical URLs
91-
- **AI Agent Discovery**: `llms.txt`, `llms-full.txt`, `.well-known/agent.json`, per-skill `.md` endpoints
91+
- **Skills Discovery**: `llms.txt`, `llms-full.txt`, `.well-known/skills/` ([Skills Discovery RFC](https://github.com/cloudflare/agent-skills-discovery-rfc))
9292

9393
## License
9494

0 commit comments

Comments
 (0)