You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -249,7 +249,7 @@ Other important repository files:
249
249
-[`cli/ManagedCode.DotnetAgents/ManagedCode.DotnetAgents.csproj`](cli/ManagedCode.DotnetAgents/ManagedCode.DotnetAgents.csproj): publishable `.NET` tool that installs orchestration agents through `dotnet agents ...`.
250
250
-[`cli/ManagedCode.Agents/ManagedCode.Agents.csproj`](cli/ManagedCode.Agents/ManagedCode.Agents.csproj): publishable `.NET` tool that installs orchestration agents through `agents ...`.
251
251
-[`dotnet-skills.slnx`](dotnet-skills.slnx): canonical solution entry point for repository-level `dotnet build` and `dotnet pack` commands.
252
-
-[`scripts/generate_catalog.py`](scripts/generate_catalog.py): catalog scanner, README generator, and validation entry point.
252
+
-[`scripts/generate_catalog.py`](scripts/generate_catalog.py): catalog scanner, validation entry point, and optional transient manifest exporter.
253
253
-[`scripts/generate_catalog_definitions.py`](scripts/generate_catalog_definitions.py): build-time generator that derives catalog categories and type directories from scanned manifests and emits `.g.cs` definitions for the CLI runtime.
254
254
-[`scripts/generate_agent_catalog.py`](scripts/generate_agent_catalog.py): agent-catalog validation and optional export helper.
255
255
-[`scripts/smoke_test_tool.sh`](scripts/smoke_test_tool.sh): CI smoke test for the installable tool package.
@@ -380,21 +380,21 @@ Rules:
380
380
381
381
## README Maintenance Rules
382
382
383
-
[`README.md`](README.md) is the public index for the catalog.
383
+
[`README.md`](README.md) is the concise public entry point for the project. The browsable catalog belongs on [skills.managed-code.com](https://skills.managed-code.com/), not as an embedded skill table in the README.
384
384
385
385
Whenever you add, rename, split, merge, or remove a skill:
386
386
387
387
1. For repo-authored entries, update `SKILL.md` frontmatter only for `name`, `description`, or `compatibility`, and update the sibling `manifest.json` for `version`, `category`, `packages`, or `package_prefix`. For imported upstream entries, keep `SKILL.md` verbatim and put any local-only metadata in the sibling `manifest.json`.
388
-
2.Update the skill count if it is listed.
388
+
2.Do not add an exact skill count or a generated catalog table to README.
389
389
3. Update automation notes if watch coverage changes.
390
-
4.Let the release workflows generate fresh catalog outputs in CI; run `python3 scripts/generate_catalog.py` locally only when you need a preview.
390
+
4.Keep the README catalog call to action linked to `https://skills.managed-code.com/skills/`.
391
391
392
392
The source of truth is the scanned `catalog/<type>/<package>/` tree: package `manifest.json`, nested `skills/*/SKILL.md`, and nested `agents/*/AGENT.md`. Do not introduce or rely on checked-in aggregate catalog JSON files as the source of truth.
393
-
Do not hand-edit the generated catalog section between `<!-- BEGIN GENERATED CATALOG -->` and `<!-- END GENERATED CATALOG -->`.
394
393
395
394
Generated catalog outputs:
396
395
397
-
-[`README.md`](README.md) catalog section
396
+
- public site pages generated by [`scripts/generate_pages.py`](scripts/generate_pages.py)
397
+
- transient release manifests generated explicitly with `scripts/generate_catalog.py --manifest-output <path>`
398
398
399
399
Canonical generation point:
400
400
@@ -611,7 +611,7 @@ For skill and docs changes:
611
611
- Verify README links and catalog entries are correct.
- run `python3 scripts/generate_catalog.py` locally only when you explicitly need a preview of the generated README and manifest
614
+
- run `python3 scripts/generate_catalog.py --manifest-output <path>`only when you explicitly need a transient manifest export
615
615
616
616
For agent and docs changes:
617
617
@@ -688,8 +688,8 @@ This repository should behave like a maintainable documentation-and-automation s
688
688
- On dense directory pages such as `/skills/`, catalog cards must use a strict shared composition so the grid reads as deliberate: matching heights per row, stable title/summary/meta/action bands, and line clamping where needed instead of ragged card growth.
689
689
- Directory cards that represent navigable resources such as categories should make the whole card feel interactive. Do not leave large dead zones where only a small nested button or heading opens the destination.
690
690
- The public skills site should visually align with the main ManagedCode website rather than inventing a separate noisy catalog aesthetic. When redesigning the site, inspect live ManagedCode pages first and reuse their calmer premium typography, spacing, accent restraint, and overall tone.
691
-
- Public README hero copy must avoid exact skill counts in the top badge and intro line; keep precise counts only in the generated catalog section where they can stay authoritative.
692
-
-The README header generator must normalize duplicate generated lines after merges; one canonical top Skills badge and one canonical intro line only.
691
+
- Public README copy must avoid exact skill counts and embedded skill tables. Direct catalog browsing to `https://skills.managed-code.com/skills/`.
692
+
-Keep one canonical top Skills badge and one canonical intro line in README.
693
693
- For internal `SKILL.md`, `AGENT.md`, and `references/` content, optimize first for model loading and token economy. Human clickability or decorative Markdown formatting is secondary unless it materially improves maintenance.
694
694
695
695
### Dislikes
@@ -707,17 +707,17 @@ This repository should behave like a maintainable documentation-and-automation s
707
707
- Bloated spacing on the public landing page, especially in Quick Start shells, step stacks, and sidebar cards.
708
708
- Broken skill-card footers where category badges and install commands overlap, wrap awkwardly, or compete for the same horizontal space.
709
709
- Exact skill counts in the public README hero badge or intro copy, where they go stale and create pointless merge churn.
710
-
-README generators that update only the first header occurrence and leave duplicate Skills badges or duplicate intro lines behind after merges.
710
+
-Full generated catalog tables in README; the public site is the canonical browse surface.
711
711
- Rewriting concise internal reference paths into verbose Markdown-link syntax when that does not help the model.
712
712
713
713
## Anti-Patterns
714
714
715
715
Do not do these:
716
716
717
717
- Create duplicate skill trees.
718
-
- Add frameworks without updating the generated catalog inputs and regenerating README.
718
+
- Add frameworks without updating the catalog inputs and validating the public site generator.
719
719
- Add watch entries without mapping them to affected skills.
720
720
- Hand-edit the state file instead of syncing it.
721
-
-Hand-edit the generated README catalog section.
721
+
-Embed or regenerate the full catalog in README.
722
722
- Use noisy GitHub release watches without filtering mixed release streams.
723
723
- Base skill logic on unofficial or stale sources when official docs exist.
0 commit comments