Skip to content

Commit 033eb68

Browse files
committed
[doc] refactor: co-locate technique skills with machine-readable cards
Move perf-technique skills from flat .md files to subfolders with SKILL.md + card.yaml, consolidating knowledge/techniques/ YAML cards alongside their skills. Add resiliency skill and card. Refactor docs/training/resiliency.md to be concise conceptual docs, offloading operational details to skills/resiliency/SKILL.md. Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Made-with: Cursor
1 parent 5c31754 commit 033eb68

File tree

20 files changed

+567
-748
lines changed

20 files changed

+567
-748
lines changed

docs/training/hybrid-context-parallel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ all Bridge initialization modes.
6060

6161
- `docs/performance-guide.md`
6262
- `docs/training/communication-overlap.md`
63-
- `skills/perf-techniques/hybrid-context-parallel.md`
64-
- `knowledge/techniques/hybrid_context_parallel.yaml`
63+
- `skills/perf-techniques/hybrid-context-parallel/SKILL.md`
64+
- `skills/perf-techniques/hybrid-context-parallel/card.yaml`

docs/training/megatron-fsdp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ The stable recommendation today is:
9898
- `docs/training/cpu-offloading.md`
9999
- `docs/performance-guide.md`
100100
- `skills/perf-techniques/megatron-fsdp.md`
101-
- `knowledge/techniques/megatron_fsdp.yaml`
101+
- `skills/perf-techniques/megatron-fsdp/card.yaml`

docs/training/packed-sequences.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ The most stable caveats to remember are:
8686
- `docs/performance-guide.md`
8787
- `docs/training/hybrid-context-parallel.md`
8888
- `skills/perf-techniques/sequence-packing.md`
89-
- `knowledge/techniques/packed_sequences_long_context.yaml`
89+
- `skills/perf-techniques/sequence-packing/card.yaml`

docs/training/resiliency.md

Lines changed: 117 additions & 723 deletions
Large diffs are not rendered by default.

knowledge/techniques/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# Technique Knowledge Cards
1+
# Technique Knowledge Cards — Moved
22

3-
This directory stores structured, machine-readable technique cards.
3+
Technique cards have been co-located with their operational skills under
4+
`skills/perf-techniques/<technique>/card.yaml`.
45

5-
Use this split:
6+
Each technique folder contains:
67

7-
- `docs/training/*.md` for stable human-facing guidance such as what a
8-
technique is, when to use it, and durable conclusions.
9-
- `knowledge/techniques/*.yaml` for compact structured metadata, validation
10-
status, constraints, and evidence pointers.
11-
- `skills/perf-techniques/*.md` for operational guidance such as enablement,
12-
code anchors, pitfalls, and verification commands.
8+
- `SKILL.md` — operational guide (enablement, code anchors, pitfalls, verification)
9+
- `card.yaml` — structured metadata (validation status, constraints, evidence)
10+
11+
Stable human-facing docs remain in `docs/training/*.md`.

skills/perf-techniques/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
This directory stores operational guides for performance and parallelism
44
techniques.
55

6-
Use this split:
7-
8-
- `docs/training/*.md` for stable, human-facing guidance such as what a
9-
technique is, when to use it, and durable conclusions.
10-
- `knowledge/techniques/*.yaml` for structured machine-readable technique cards.
11-
- `skills/perf-techniques/*.md` for code-near operational guidance such as how
12-
to enable a technique, important pitfalls, source-code anchors, and
13-
verification commands.
6+
Each technique lives in its own subfolder with two files:
7+
8+
- `SKILL.md` — operational guide (enablement, code anchors, pitfalls,
9+
verification)
10+
- `card.yaml` machine-readable structured metadata (validation status,
11+
constraints, evidence)
12+
13+
Stable human-facing docs live in `docs/training/*.md`.
File renamed without changes.
File renamed without changes.

skills/perf-techniques/hybrid-context-parallel.md renamed to skills/perf-techniques/hybrid-context-parallel/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Operational guide for enabling hierarchical context parallelism in
88
For stable background and recommendation level, see:
99

1010
- `docs/training/hybrid-context-parallel.md`
11-
- `knowledge/techniques/hybrid_context_parallel.yaml`
11+
- `card.yaml` (co-located)
1212

1313
## Enablement
1414

File renamed without changes.

0 commit comments

Comments
 (0)