Skip to content

Commit d39f60b

Browse files
committed
feat: add AGENTS.md, rebuild GitHub Pages with fixed template
Add AGENTS.md with repo structure, skills, rules, MCP tools, and CI docs. Rebuild docs site with fixed skill parser and QoL features (collapsible categories, search/filter, back-to-top, toast, mobile nav). Made-with: Cursor
1 parent 60ce08a commit d39f60b

2 files changed

Lines changed: 555 additions & 532 deletions

File tree

AGENTS.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# AGENTS.md
2+
3+
Guidance for AI coding agents working on the Steam Cursor Plugin repository.
4+
5+
## Repository overview
6+
7+
A Cursor IDE plugin for Steam and Steamworks integration. 30 skills and 9 rules covering store data, achievements, Workshop, multiplayer, cloud saves, and game development workflows. 25 MCP tools via companion server.
8+
9+
**Docs site:** https://tmhsdigital.github.io/Steam-Cursor-Plugin/
10+
11+
## Repository structure
12+
13+
```
14+
Steam-Cursor-Plugin/
15+
.cursor-plugin/plugin.json # Plugin manifest (name, version, description)
16+
skills/ # 30 skill directories, each with SKILL.md
17+
rules/ # 9 rule files (.mdc)
18+
mcp-tools.json # MCP tool catalog (25 tools, manually maintained)
19+
site.json # GitHub Pages branding/config
20+
docs/ # Generated GitHub Pages site (do not edit manually)
21+
assets/ # Logo and images
22+
tests/ # Test suite
23+
.github/workflows/ # CI/CD (ci, codeql, dep-review, links, pages, release-drafter, stale, validate)
24+
```
25+
26+
## Branching and commit model
27+
28+
- **Single branch:** `main` only
29+
- **Conventional commits:** `feat:`, `fix:`, `chore:`, `docs:`
30+
31+
## Skills
32+
33+
Each skill lives in `skills/<skill-name>/SKILL.md`. Every SKILL.md starts with YAML frontmatter:
34+
35+
```yaml
36+
---
37+
name: skill-name
38+
description: One-line description of what the skill does
39+
---
40+
```
41+
42+
The `name` and `description` fields are parsed by the site template build system to generate the GitHub Pages site. When adding a new skill:
43+
1. Create `skills/<skill-name>/SKILL.md` with frontmatter
44+
2. Update the `skills` count in `.cursor-plugin/plugin.json`
45+
3. Use `feat:` commit prefix
46+
47+
## Rules
48+
49+
Rules are `.mdc` files in `rules/`. Each starts with YAML frontmatter containing `description` and `globs` fields.
50+
51+
## MCP Tools
52+
53+
`mcp-tools.json` is a manually maintained JSON array of all MCP tools. Each entry has `name`, `description`, and `category` fields. This file is used by the GitHub Pages build system to render the tools catalog.
54+
55+
## GitHub Pages
56+
57+
The docs site is auto-generated. Do not edit `docs/index.html` directly. It is built by the shared template system from the Developer-Tools-Directory repo.
58+
59+
Data sources:
60+
- `.cursor-plugin/plugin.json` -- metadata
61+
- `site.json` -- branding (accent color, install steps, links)
62+
- `skills/*/SKILL.md` -- parsed for name/description via frontmatter
63+
- `rules/*.mdc` -- parsed for name/scope/description
64+
- `mcp-tools.json` -- tool catalog
65+
66+
The `pages.yml` workflow clones Developer-Tools-Directory, runs `build_site.py`, and deploys the output.
67+
68+
## CI/CD workflows
69+
70+
- `ci.yml` -- runs tests on push/PR
71+
- `validate.yml` -- validates plugin.json schema
72+
- `pages.yml` -- builds and deploys GitHub Pages via shared template
73+
- `codeql.yml` -- security scanning
74+
- `dependency-review.yml` -- audits PR dependencies
75+
- `release-drafter.yml` -- auto-drafts release notes
76+
- `stale.yml` -- marks/closes inactive issues and PRs
77+
- `links.yml` -- checks for broken links
78+
79+
## Key conventions
80+
81+
- No em dashes or en dashes -- use hyphens or rewrite
82+
- No hardcoded credentials, tokens, or API keys
83+
- Conventional commits required
84+
- CC-BY-NC-ND-4.0 license
85+
- All content written for public readership

0 commit comments

Comments
 (0)