Commit fdc2446
authored
docs: simplify README + add add-mcpp-index-package skill (#51)
* docs(skills): add `add-mcpp-index-package` agent skill (SOP)
Codifies the full process used for cjson/nlohmann/eigen into a reusable skill
under .agents/skills/add-mcpp-index-package/:
- SKILL.md — 12-step SOP, the sources-only feature gate (+ mandatory negative
test), version-matched local verification, red-flags/common mistakes.
- package-types.md — descriptor templates for the four shapes (C-source
compat / header-only / C++23 module via generated wrapper / external Form-A
module repo), each with real sample paths.
- cn-mirror.md — gtc/gitcode mcpp-res mirror closed loop + every known gotcha.
- references.md — repo layout, descriptor schema cheat-sheet, validate.yml CI
behavior, one-shot local lint, real worked examples (#48 / #50).
* docs(readme): slim down to intro + usage + contribution + links
Drop the package tables/dependency tree/smoke breakdown/Form-A-B examples from
the index README — the browsable site (mcpplibs.github.io/mcpp-index) is the
package list, and the how-to detail lives in the add-mcpp-index-package skill.
README now = what it is, mcpp add/build usage, the two package categories
(native module libs / third-party compat) with a pointer to the skill, and
related tools / community.
* docs: add docs/, README example table + agent prompt; skill mirror fallback
- Move the skill's reference files into a human-facing docs/ folder (single
source): package-types.md, cn-mirror.md, repository-and-schema.md (+ index
docs/README.md). SKILL.md now links to ../../../docs/*; the skill dir keeps
just SKILL.md (the agent SOP).
- README: add a "参考示例" table linking typical descriptors by shape
(Form-A module / C-source compat / header-only / module wrapper), a
copy-paste agent prompt that drives the skill end-to-end, and links to docs/.
- skill + docs: document the no-`mcpp-res`-permission fallback — use a
plain-string upstream `url` (lint forbids a {GLOBAL,CN} table whose CN isn't
gitcode/mcpp-res; plain strings are unconstrained). Real precedent:
pkgs/t/tensorvia-cpu.lua.
- skill step 1 now distinguishes the two sources: a third-party upstream lib
vs. the user's own mcpp-based library (Form A, lighter research).
* docs: rewrite README/docs/skill in a formal declarative register
Rewrite all prose across README.md, docs/*, and the add-mcpp-index-package
skill into declarative, academic-style Chinese: remove colloquial terms
(一把梭 / 踩坑 / 丢给 / 硬凑 / 藏不住 …) and decorative emoji (1 parent a240c7f commit fdc2446
6 files changed
Lines changed: 523 additions & 258 deletions
File tree
- .agents/skills/add-mcpp-index-package
- docs
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
0 commit comments