docs(packaging): professionalize packages index and link it in README
This commit is contained in:
@@ -23,7 +23,7 @@ Main outputs:
|
|||||||
- `package/per-skill/skill/<skill-name>.skill`
|
- `package/per-skill/skill/<skill-name>.skill`
|
||||||
- `package/per-skill/zip/<skill-name>.zip`
|
- `package/per-skill/zip/<skill-name>.zip`
|
||||||
- `package/bundles/mechanical-skills-collection.zip`
|
- `package/bundles/mechanical-skills-collection.zip`
|
||||||
- `package/PACKAGES_INDEX.md`
|
- [`package/PACKAGES_INDEX.md`](package/PACKAGES_INDEX.md)
|
||||||
|
|
||||||
### Package folder definitions
|
### Package folder definitions
|
||||||
- `package/per-skill/`
|
- `package/per-skill/`
|
||||||
@@ -59,14 +59,14 @@ python3 script/package_skills.py
|
|||||||
|
|
||||||
5. Check results:
|
5. Check results:
|
||||||
- Per-skill package files in `package/per-skill/skill/` and `package/per-skill/zip/`
|
- Per-skill package files in `package/per-skill/skill/` and `package/per-skill/zip/`
|
||||||
- Validation report in `package/PACKAGES_INDEX.md`
|
- Validation report in [`package/PACKAGES_INDEX.md`](package/PACKAGES_INDEX.md)
|
||||||
6. Import into Claude:
|
6. Import into Claude:
|
||||||
- Upload `package/per-skill/skill/my-new-skill.skill` (or `.zip` from `package/per-skill/zip/`).
|
- Upload `package/per-skill/skill/my-new-skill.skill` (or `.zip` from `package/per-skill/zip/`).
|
||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
- If a skill is missing `SKILL.md`, it is skipped.
|
- If a skill is missing `SKILL.md`, it is skipped.
|
||||||
- If `name` or `description` is missing in frontmatter, it is skipped.
|
- If `name` or `description` is missing in frontmatter, it is skipped.
|
||||||
- If two skills use the same `name`, the script auto-adds a suffix and logs a warning in `PACKAGES_INDEX.md`.
|
- If two skills use the same `name`, the script auto-adds a suffix and logs a warning in [`PACKAGES_INDEX.md`](package/PACKAGES_INDEX.md).
|
||||||
|
|
||||||
## Detailed Skill Authoring Guide (Claude-Style)
|
## Detailed Skill Authoring Guide (Claude-Style)
|
||||||
This section mirrors the depth of the official Claude Skills guidance and adapts it to this repository.
|
This section mirrors the depth of the official Claude Skills guidance and adapts it to this repository.
|
||||||
@@ -254,7 +254,7 @@ Generated artifacts:
|
|||||||
- `package/per-skill/skill/<skill-name>.skill`
|
- `package/per-skill/skill/<skill-name>.skill`
|
||||||
- `package/per-skill/zip/<skill-name>.zip`
|
- `package/per-skill/zip/<skill-name>.zip`
|
||||||
- `package/bundles/mechanical-skills-collection.zip`
|
- `package/bundles/mechanical-skills-collection.zip`
|
||||||
- `package/PACKAGES_INDEX.md` (validation summary, warnings, skipped items)
|
- [`package/PACKAGES_INDEX.md`](package/PACKAGES_INDEX.md) (validation summary, warnings, skipped items)
|
||||||
|
|
||||||
A skill is skipped by the packager if:
|
A skill is skipped by the packager if:
|
||||||
- `SKILL.md` is missing.
|
- `SKILL.md` is missing.
|
||||||
|
|||||||
@@ -1,13 +1,14 @@
|
|||||||
# Packages Index
|
# Mechanical Skills Packages Index
|
||||||
|
|
||||||
## Snapshot
|
## Snapshot
|
||||||
|
|
||||||
- Generated (UTC): **2026-03-19 14:20:08 UTC**
|
| Item | Value |
|
||||||
- Skills root: `/home/davide/cev-skills/skill`
|
| --- | --- |
|
||||||
- Valid skills packaged: **34**
|
| Generated (UTC) | `2026-03-19 14:25:13 UTC` |
|
||||||
- Per-skill formats: `.skill` and `.zip` in separate folders
|
| Valid skills packaged | **34** |
|
||||||
- Bundle: [`mechanical-skills-collection.zip`](bundles/mechanical-skills-collection.zip)
|
| Per-skill formats | `.skill` and `.zip` (separate folders) |
|
||||||
- Validation status: **PASS**
|
| Bundle | [`mechanical-skills-collection.zip`](bundles/mechanical-skills-collection.zip) |
|
||||||
|
| Validation status | **PASS** (8/8) |
|
||||||
|
|
||||||
## Quick Links
|
## Quick Links
|
||||||
|
|
||||||
@@ -20,44 +21,44 @@
|
|||||||
|
|
||||||
## Skill Catalog
|
## Skill Catalog
|
||||||
|
|
||||||
| Skill | Description | Source | Markdown | .skill | .zip |
|
| Skill | Scope | Source | Packages | Markdown |
|
||||||
| --- | --- | --- | --- | --- | --- |
|
| --- | --- | --- | --- | --- |
|
||||||
| `bearings-seals-selection` | Bearing and seal selection for rotating equipment. Use this skill whenever the user asks about bearing type/life, preload, lubrication, sealing, contamination control, or shaft support architecture. | [`bearings-seals-selection/SKILL.md`](../skill/bearings-seals-selection/SKILL.md) | [`bearings-seals-selection.md`](upload-md/bearings-seals-selection.md) | [`bearings-seals-selection.skill`](per-skill/skill/bearings-seals-selection.skill) | [`bearings-seals-selection.zip`](per-skill/zip/bearings-seals-selection.zip) |
|
| `bearings-seals-selection` | Bearing and seal selection for rotating equipment. | [`bearings-seals-selection/SKILL.md`](../skill/bearings-seals-selection/SKILL.md) | [`.skill`](per-skill/skill/bearings-seals-selection.skill) / [`.zip`](per-skill/zip/bearings-seals-selection.zip) | [`bearings-seals-selection.md`](upload-md/bearings-seals-selection.md) |
|
||||||
| `calculation-report` | Calculation report preparation for auditable engineering calculations. Use this skill whenever the user needs formal calculation packs with equations, assumptions, units, and compliance-ready traceability. | [`calculation-report/SKILL.md`](../skill/calculation-report/SKILL.md) | [`calculation-report.md`](upload-md/calculation-report.md) | [`calculation-report.skill`](per-skill/skill/calculation-report.skill) | [`calculation-report.zip`](per-skill/zip/calculation-report.zip) |
|
| `calculation-report` | Calculation report preparation for auditable engineering calculations. | [`calculation-report/SKILL.md`](../skill/calculation-report/SKILL.md) | [`.skill`](per-skill/skill/calculation-report.skill) / [`.zip`](per-skill/zip/calculation-report.zip) | [`calculation-report.md`](upload-md/calculation-report.md) |
|
||||||
| `cnc-sheet-casting-forging` | Detailed manufacturing guidance for CNC machining, sheet metal, casting, and forging. Use this skill whenever the user requests geometry rules, draft/radii, tool access, or redesign for a specific process family. | [`cnc-sheet-casting-forging/SKILL.md`](../skill/cnc-sheet-casting-forging/SKILL.md) | [`cnc-sheet-casting-forging.md`](upload-md/cnc-sheet-casting-forging.md) | [`cnc-sheet-casting-forging.skill`](per-skill/skill/cnc-sheet-casting-forging.skill) | [`cnc-sheet-casting-forging.zip`](per-skill/zip/cnc-sheet-casting-forging.zip) |
|
| `cnc-sheet-casting-forging` | Detailed manufacturing guidance for CNC machining, sheet metal, casting, and forging. | [`cnc-sheet-casting-forging/SKILL.md`](../skill/cnc-sheet-casting-forging/SKILL.md) | [`.skill`](per-skill/skill/cnc-sheet-casting-forging.skill) / [`.zip`](per-skill/zip/cnc-sheet-casting-forging.zip) | [`cnc-sheet-casting-forging.md`](upload-md/cnc-sheet-casting-forging.md) |
|
||||||
| `design-review-fmea` | Structured design review and FMEA for risk reduction. Use this skill whenever the user asks for design review checklists, failure prevention planning, or prioritization of design risks before release. | [`design-review-fmea/SKILL.md`](../skill/design-review-fmea/SKILL.md) | [`design-review-fmea.md`](upload-md/design-review-fmea.md) | [`design-review-fmea.skill`](per-skill/skill/design-review-fmea.skill) | [`design-review-fmea.zip`](per-skill/zip/design-review-fmea.zip) |
|
| `design-review-fmea` | Structured design review and FMEA for risk reduction. | [`design-review-fmea/SKILL.md`](../skill/design-review-fmea/SKILL.md) | [`.skill`](per-skill/skill/design-review-fmea.skill) / [`.zip`](per-skill/zip/design-review-fmea.zip) | [`design-review-fmea.md`](upload-md/design-review-fmea.md) |
|
||||||
| `dfm-dfa-review` | Design for manufacturing and assembly review for mechanical products. Use this skill whenever the user asks if a design is producible/assemblable, wants part-count reduction, or needs robust assembly flow. | [`dfm-dfa-review/SKILL.md`](../skill/dfm-dfa-review/SKILL.md) | [`dfm-dfa-review.md`](upload-md/dfm-dfa-review.md) | [`dfm-dfa-review.skill`](per-skill/skill/dfm-dfa-review.skill) | [`dfm-dfa-review.zip`](per-skill/zip/dfm-dfa-review.zip) |
|
| `dfm-dfa-review` | Design for manufacturing and assembly review for mechanical products. | [`dfm-dfa-review/SKILL.md`](../skill/dfm-dfa-review/SKILL.md) | [`.skill`](per-skill/skill/dfm-dfa-review.skill) / [`.zip`](per-skill/zip/dfm-dfa-review.zip) | [`dfm-dfa-review.md`](upload-md/dfm-dfa-review.md) |
|
||||||
| `dynamics-vibrations-analysis` | Rigid-body dynamics and vibration response analysis. Use this skill whenever the user asks about motion, acceleration loads, resonance, transmissibility, balancing, or dynamic amplification in machines. | [`dynamics-vibrations-analysis/SKILL.md`](../skill/dynamics-vibrations-analysis/SKILL.md) | [`dynamics-vibrations-analysis.md`](upload-md/dynamics-vibrations-analysis.md) | [`dynamics-vibrations-analysis.skill`](per-skill/skill/dynamics-vibrations-analysis.skill) | [`dynamics-vibrations-analysis.zip`](per-skill/zip/dynamics-vibrations-analysis.zip) |
|
| `dynamics-vibrations-analysis` | Rigid-body dynamics and vibration response analysis. | [`dynamics-vibrations-analysis/SKILL.md`](../skill/dynamics-vibrations-analysis/SKILL.md) | [`.skill`](per-skill/skill/dynamics-vibrations-analysis.skill) / [`.zip`](per-skill/zip/dynamics-vibrations-analysis.zip) | [`dynamics-vibrations-analysis.md`](upload-md/dynamics-vibrations-analysis.md) |
|
||||||
| `energy-efficiency-analysis` | Energy efficiency optimization for mechanical and thermo-fluid systems. Use this skill whenever the user wants to reduce energy consumption, compare efficiency options, or evaluate lifecycle energy impact of design choices. | [`energy-efficiency-analysis/SKILL.md`](../skill/energy-efficiency-analysis/SKILL.md) | [`energy-efficiency-analysis.md`](upload-md/energy-efficiency-analysis.md) | [`energy-efficiency-analysis.skill`](per-skill/skill/energy-efficiency-analysis.skill) | [`energy-efficiency-analysis.zip`](per-skill/zip/energy-efficiency-analysis.zip) |
|
| `energy-efficiency-analysis` | Energy efficiency optimization for mechanical and thermo-fluid systems. | [`energy-efficiency-analysis/SKILL.md`](../skill/energy-efficiency-analysis/SKILL.md) | [`.skill`](per-skill/skill/energy-efficiency-analysis.skill) / [`.zip`](per-skill/zip/energy-efficiency-analysis.zip) | [`energy-efficiency-analysis.md`](upload-md/energy-efficiency-analysis.md) |
|
||||||
| `failure-root-cause-analysis` | Root cause analysis for field or test failures in mechanical systems. Use this skill whenever the user asks why a failure happened, needs 5-Why/fishbone evidence, or must define corrective actions. | [`failure-root-cause-analysis/SKILL.md`](../skill/failure-root-cause-analysis/SKILL.md) | [`failure-root-cause-analysis.md`](upload-md/failure-root-cause-analysis.md) | [`failure-root-cause-analysis.skill`](per-skill/skill/failure-root-cause-analysis.skill) | [`failure-root-cause-analysis.zip`](per-skill/zip/failure-root-cause-analysis.zip) |
|
| `failure-root-cause-analysis` | Root cause analysis for field or test failures in mechanical systems. | [`failure-root-cause-analysis/SKILL.md`](../skill/failure-root-cause-analysis/SKILL.md) | [`.skill`](per-skill/skill/failure-root-cause-analysis.skill) / [`.zip`](per-skill/zip/failure-root-cause-analysis.zip) | [`failure-root-cause-analysis.md`](upload-md/failure-root-cause-analysis.md) |
|
||||||
| `fatigue-fracture-analysis` | Fatigue life and fracture risk assessment for cyclic loading. Use this skill whenever the user mentions S-N life, crack growth, endurance, variable amplitude cycles, weld fatigue, or brittle/ductile fracture concerns, even if test data is limited. | [`fatigue-fracture-analysis/SKILL.md`](../skill/fatigue-fracture-analysis/SKILL.md) | [`fatigue-fracture-analysis.md`](upload-md/fatigue-fracture-analysis.md) | [`fatigue-fracture-analysis.skill`](per-skill/skill/fatigue-fracture-analysis.skill) | [`fatigue-fracture-analysis.zip`](per-skill/zip/fatigue-fracture-analysis.zip) |
|
| `fatigue-fracture-analysis` | Fatigue life and fracture risk assessment for cyclic loading. | [`fatigue-fracture-analysis/SKILL.md`](../skill/fatigue-fracture-analysis/SKILL.md) | [`.skill`](per-skill/skill/fatigue-fracture-analysis.skill) / [`.zip`](per-skill/zip/fatigue-fracture-analysis.zip) | [`fatigue-fracture-analysis.md`](upload-md/fatigue-fracture-analysis.md) |
|
||||||
| `fea-cfd-review` | Critical review of FEA/CFD models and simulation credibility. Use this skill whenever the user asks to validate simulation setup/results, challenge assumptions, or decide if analysis is decision-ready. | [`fea-cfd-review/SKILL.md`](../skill/fea-cfd-review/SKILL.md) | [`fea-cfd-review.md`](upload-md/fea-cfd-review.md) | [`fea-cfd-review.skill`](per-skill/skill/fea-cfd-review.skill) | [`fea-cfd-review.zip`](per-skill/zip/fea-cfd-review.zip) |
|
| `fea-cfd-review` | Critical review of FEA/CFD models and simulation credibility. | [`fea-cfd-review/SKILL.md`](../skill/fea-cfd-review/SKILL.md) | [`.skill`](per-skill/skill/fea-cfd-review.skill) / [`.zip`](per-skill/zip/fea-cfd-review.zip) | [`fea-cfd-review.md`](upload-md/fea-cfd-review.md) |
|
||||||
| `fluid-analysis` | Internal and external fluid flow analysis for engineering systems. Use this skill whenever the user asks about flow rate, pressure drop, Reynolds regime, valve/piping behavior, or fluid-system sizing. | [`fluid-analysis/SKILL.md`](../skill/fluid-analysis/SKILL.md) | [`fluid-analysis.md`](upload-md/fluid-analysis.md) | [`fluid-analysis.skill`](per-skill/skill/fluid-analysis.skill) | [`fluid-analysis.zip`](per-skill/zip/fluid-analysis.zip) |
|
| `fluid-analysis` | Internal and external fluid flow analysis for engineering systems. | [`fluid-analysis/SKILL.md`](../skill/fluid-analysis/SKILL.md) | [`.skill`](per-skill/skill/fluid-analysis.skill) / [`.zip`](per-skill/zip/fluid-analysis.zip) | [`fluid-analysis.md`](upload-md/fluid-analysis.md) |
|
||||||
| `gear-design` | Gear train design and verification for power transmission. Use this skill whenever the user asks about gear geometry, ratio selection, tooth stresses, micropitting/scuffing, or gearbox design tradeoffs. | [`gear-design/SKILL.md`](../skill/gear-design/SKILL.md) | [`gear-design.md`](upload-md/gear-design.md) | [`gear-design.skill`](per-skill/skill/gear-design.skill) | [`gear-design.zip`](per-skill/zip/gear-design.zip) |
|
| `gear-design` | Gear train design and verification for power transmission. | [`gear-design/SKILL.md`](../skill/gear-design/SKILL.md) | [`.skill`](per-skill/skill/gear-design.skill) / [`.zip`](per-skill/zip/gear-design.zip) | [`gear-design.md`](upload-md/gear-design.md) |
|
||||||
| `heat-treatment` | Heat-treatment strategy for steels and alloys in mechanical design. Use this skill whenever the user asks about hardening, tempering, case depth, residual stresses, distortion, or hardness-toughness tradeoffs. | [`heat-treatment/SKILL.md`](../skill/heat-treatment/SKILL.md) | [`heat-treatment.md`](upload-md/heat-treatment.md) | [`heat-treatment.skill`](per-skill/skill/heat-treatment.skill) | [`heat-treatment.zip`](per-skill/zip/heat-treatment.zip) |
|
| `heat-treatment` | Heat-treatment strategy for steels and alloys in mechanical design. | [`heat-treatment/SKILL.md`](../skill/heat-treatment/SKILL.md) | [`.skill`](per-skill/skill/heat-treatment.skill) / [`.zip`](per-skill/zip/heat-treatment.zip) | [`heat-treatment.md`](upload-md/heat-treatment.md) |
|
||||||
| `joints-design` | Joint design for bolts, welds, adhesives, and hybrid joints. Use this skill whenever the user asks how to join parts or verify joint integrity under static, fatigue, thermal, or corrosive conditions. | [`joints-design/SKILL.md`](../skill/joints-design/SKILL.md) | [`joints-design.md`](upload-md/joints-design.md) | [`joints-design.skill`](per-skill/skill/joints-design.skill) | [`joints-design.zip`](per-skill/zip/joints-design.zip) |
|
| `joints-design` | Joint design for bolts, welds, adhesives, and hybrid joints. | [`joints-design/SKILL.md`](../skill/joints-design/SKILL.md) | [`.skill`](per-skill/skill/joints-design.skill) / [`.zip`](per-skill/zip/joints-design.zip) | [`joints-design.md`](upload-md/joints-design.md) |
|
||||||
| `machine-elements-selection` | Integrated selection of machine elements for a mechanism or subsystem. Use this skill whenever the user asks to choose among bearings/gears/springs/joints/couplings under constraints of reliability, cost, and manufacturability. | [`machine-elements-selection/SKILL.md`](../skill/machine-elements-selection/SKILL.md) | [`machine-elements-selection.md`](upload-md/machine-elements-selection.md) | [`machine-elements-selection.skill`](per-skill/skill/machine-elements-selection.skill) | [`machine-elements-selection.zip`](per-skill/zip/machine-elements-selection.zip) |
|
| `machine-elements-selection` | Integrated selection of machine elements for a mechanism or subsystem. | [`machine-elements-selection/SKILL.md`](../skill/machine-elements-selection/SKILL.md) | [`.skill`](per-skill/skill/machine-elements-selection.skill) / [`.zip`](per-skill/zip/machine-elements-selection.zip) | [`machine-elements-selection.md`](upload-md/machine-elements-selection.md) |
|
||||||
| `material-failure-modes` | Material failure mode identification and prevention. Use this skill whenever the user asks about yielding, brittle fracture, creep, wear, corrosion-assisted cracking, or unexplained material degradation. | [`material-failure-modes/SKILL.md`](../skill/material-failure-modes/SKILL.md) | [`material-failure-modes.md`](upload-md/material-failure-modes.md) | [`material-failure-modes.skill`](per-skill/skill/material-failure-modes.skill) | [`material-failure-modes.zip`](per-skill/zip/material-failure-modes.zip) |
|
| `material-failure-modes` | Material failure mode identification and prevention. | [`material-failure-modes/SKILL.md`](../skill/material-failure-modes/SKILL.md) | [`.skill`](per-skill/skill/material-failure-modes.skill) / [`.zip`](per-skill/zip/material-failure-modes.zip) | [`material-failure-modes.md`](upload-md/material-failure-modes.md) |
|
||||||
| `materials-metallurgy` | Materials engineering and metallurgy guidance for design decisions. Use this skill whenever the user asks to choose metals/polymers/composites, compare material behavior, or evaluate metallurgical effects on performance. | [`materials-metallurgy/SKILL.md`](../skill/materials-metallurgy/SKILL.md) | [`materials-metallurgy.md`](upload-md/materials-metallurgy.md) | [`materials-metallurgy.skill`](per-skill/skill/materials-metallurgy.skill) | [`materials-metallurgy.zip`](per-skill/zip/materials-metallurgy.zip) |
|
| `materials-metallurgy` | Materials engineering and metallurgy guidance for design decisions. | [`materials-metallurgy/SKILL.md`](../skill/materials-metallurgy/SKILL.md) | [`.skill`](per-skill/skill/materials-metallurgy.skill) / [`.zip`](per-skill/zip/materials-metallurgy.zip) | [`materials-metallurgy.md`](upload-md/materials-metallurgy.md) |
|
||||||
| `mechanical-orchestrator` | Cross-domain mechanical engineering orchestration for complex design questions. Use this skill whenever a request spans multiple domains (stress, fatigue, thermal, fluid, materials, manufacturing, reliability), whenever requirements are incomplete, or whenever the user asks for a senior-level decision path and prioritization, even if they do not ask for an orchestrator explicitly. | [`mechanical-orchestrator/SKILL.md`](../skill/mechanical-orchestrator/SKILL.md) | [`mechanical-orchestrator.md`](upload-md/mechanical-orchestrator.md) | [`mechanical-orchestrator.skill`](per-skill/skill/mechanical-orchestrator.skill) | [`mechanical-orchestrator.zip`](per-skill/zip/mechanical-orchestrator.zip) |
|
| `mechanical-orchestrator` | Cross-domain mechanical engineering orchestration for complex design questions. | [`mechanical-orchestrator/SKILL.md`](../skill/mechanical-orchestrator/SKILL.md) | [`.skill`](per-skill/skill/mechanical-orchestrator.skill) / [`.zip`](per-skill/zip/mechanical-orchestrator.zip) | [`mechanical-orchestrator.md`](upload-md/mechanical-orchestrator.md) |
|
||||||
| `modal-analysis` | Modal behavior assessment for structures and assemblies. Use this skill whenever the user asks for mode shapes, eigenfrequencies, modal participation, or resonance avoidance strategies in design. | [`modal-analysis/SKILL.md`](../skill/modal-analysis/SKILL.md) | [`modal-analysis.md`](upload-md/modal-analysis.md) | [`modal-analysis.skill`](per-skill/skill/modal-analysis.skill) | [`modal-analysis.zip`](per-skill/zip/modal-analysis.zip) |
|
| `modal-analysis` | Modal behavior assessment for structures and assemblies. | [`modal-analysis/SKILL.md`](../skill/modal-analysis/SKILL.md) | [`.skill`](per-skill/skill/modal-analysis.skill) / [`.zip`](per-skill/zip/modal-analysis.zip) | [`modal-analysis.md`](upload-md/modal-analysis.md) |
|
||||||
| `pressure-loss-pump-piping` | Hydraulic network design including pressure losses, pumps, and piping. Use this skill whenever the user asks about line sizing, head losses, pump selection, NPSH, or piping layout effects. | [`pressure-loss-pump-piping/SKILL.md`](../skill/pressure-loss-pump-piping/SKILL.md) | [`pressure-loss-pump-piping.md`](upload-md/pressure-loss-pump-piping.md) | [`pressure-loss-pump-piping.skill`](per-skill/skill/pressure-loss-pump-piping.skill) | [`pressure-loss-pump-piping.zip`](per-skill/zip/pressure-loss-pump-piping.zip) |
|
| `pressure-loss-pump-piping` | Hydraulic network design including pressure losses, pumps, and piping. | [`pressure-loss-pump-piping/SKILL.md`](../skill/pressure-loss-pump-piping/SKILL.md) | [`.skill`](per-skill/skill/pressure-loss-pump-piping.skill) / [`.zip`](per-skill/zip/pressure-loss-pump-piping.zip) | [`pressure-loss-pump-piping.md`](upload-md/pressure-loss-pump-piping.md) |
|
||||||
| `process-selection` | Manufacturing process selection across machining, forming, casting, additive, and joining. Use this skill whenever the user asks which process should be used for a part under cost, tolerance, volume, and material constraints. | [`process-selection/SKILL.md`](../skill/process-selection/SKILL.md) | [`process-selection.md`](upload-md/process-selection.md) | [`process-selection.skill`](per-skill/skill/process-selection.skill) | [`process-selection.zip`](per-skill/zip/process-selection.zip) |
|
| `process-selection` | Manufacturing process selection across machining, forming, casting, additive, and joining. | [`process-selection/SKILL.md`](../skill/process-selection/SKILL.md) | [`.skill`](per-skill/skill/process-selection.skill) / [`.zip`](per-skill/zip/process-selection.zip) | [`process-selection.md`](upload-md/process-selection.md) |
|
||||||
| `quality-metrology-plan` | Quality control and metrology planning for mechanical parts and assemblies. Use this skill whenever the user asks how to inspect, validate, or control critical characteristics in production. | [`quality-metrology-plan/SKILL.md`](../skill/quality-metrology-plan/SKILL.md) | [`quality-metrology-plan.md`](upload-md/quality-metrology-plan.md) | [`quality-metrology-plan.skill`](per-skill/skill/quality-metrology-plan.skill) | [`quality-metrology-plan.zip`](per-skill/zip/quality-metrology-plan.zip) |
|
| `quality-metrology-plan` | Quality control and metrology planning for mechanical parts and assemblies. | [`quality-metrology-plan/SKILL.md`](../skill/quality-metrology-plan/SKILL.md) | [`.skill`](per-skill/skill/quality-metrology-plan.skill) / [`.zip`](per-skill/zip/quality-metrology-plan.zip) | [`quality-metrology-plan.md`](upload-md/quality-metrology-plan.md) |
|
||||||
| `reliability-analysis` | Reliability engineering for mechanical products and systems. Use this skill whenever the user asks about reliability targets, MTBF, warranty risk, mission profiles, or reliability growth plans. | [`reliability-analysis/SKILL.md`](../skill/reliability-analysis/SKILL.md) | [`reliability-analysis.md`](upload-md/reliability-analysis.md) | [`reliability-analysis.skill`](per-skill/skill/reliability-analysis.skill) | [`reliability-analysis.zip`](per-skill/zip/reliability-analysis.zip) |
|
| `reliability-analysis` | Reliability engineering for mechanical products and systems. | [`reliability-analysis/SKILL.md`](../skill/reliability-analysis/SKILL.md) | [`.skill`](per-skill/skill/reliability-analysis.skill) / [`.zip`](per-skill/zip/reliability-analysis.zip) | [`reliability-analysis.md`](upload-md/reliability-analysis.md) |
|
||||||
| `shafts-couplings-design` | Shaft and coupling design for torque and alignment demands. Use this skill whenever the user asks about shaft sizing, keyways/splines, critical speed, misalignment, or coupling selection. | [`shafts-couplings-design/SKILL.md`](../skill/shafts-couplings-design/SKILL.md) | [`shafts-couplings-design.md`](upload-md/shafts-couplings-design.md) | [`shafts-couplings-design.skill`](per-skill/skill/shafts-couplings-design.skill) | [`shafts-couplings-design.zip`](per-skill/zip/shafts-couplings-design.zip) |
|
| `shafts-couplings-design` | Shaft and coupling design for torque and alignment demands. | [`shafts-couplings-design/SKILL.md`](../skill/shafts-couplings-design/SKILL.md) | [`.skill`](per-skill/skill/shafts-couplings-design.skill) / [`.zip`](per-skill/zip/shafts-couplings-design.zip) | [`shafts-couplings-design.md`](upload-md/shafts-couplings-design.md) |
|
||||||
| `should-cost-estimation` | Should-cost and cost-driver analysis for mechanical components. Use this skill whenever the user asks for target cost, quote sanity check, supplier negotiation inputs, or cost reduction options. | [`should-cost-estimation/SKILL.md`](../skill/should-cost-estimation/SKILL.md) | [`should-cost-estimation.md`](upload-md/should-cost-estimation.md) | [`should-cost-estimation.skill`](per-skill/skill/should-cost-estimation.skill) | [`should-cost-estimation.zip`](per-skill/zip/should-cost-estimation.zip) |
|
| `should-cost-estimation` | Should-cost and cost-driver analysis for mechanical components. | [`should-cost-estimation/SKILL.md`](../skill/should-cost-estimation/SKILL.md) | [`.skill`](per-skill/skill/should-cost-estimation.skill) / [`.zip`](per-skill/zip/should-cost-estimation.zip) | [`should-cost-estimation.md`](upload-md/should-cost-estimation.md) |
|
||||||
| `spring-design` | Spring design for force-deflection and life requirements. Use this skill whenever the user asks about coil/leaf/disc spring sizing, stiffness tuning, set relaxation, or cycle life. | [`spring-design/SKILL.md`](../skill/spring-design/SKILL.md) | [`spring-design.md`](upload-md/spring-design.md) | [`spring-design.skill`](per-skill/skill/spring-design.skill) | [`spring-design.zip`](per-skill/zip/spring-design.zip) |
|
| `spring-design` | Spring design for force-deflection and life requirements. | [`spring-design/SKILL.md`](../skill/spring-design/SKILL.md) | [`.skill`](per-skill/skill/spring-design.skill) / [`.zip`](per-skill/zip/spring-design.zip) | [`spring-design.md`](upload-md/spring-design.md) |
|
||||||
| `standards-compliance-check` | Engineering standards and compliance guidance for mechanical products. Use this skill whenever the user asks about ISO/EN/ASME/ASTM/API/NACE requirements, legal/contractual compliance checks, certification readiness, or design acceptability against standards, even if standard names are only partially known. | [`standards-compliance-check/SKILL.md`](../skill/standards-compliance-check/SKILL.md) | [`standards-compliance-check.md`](upload-md/standards-compliance-check.md) | [`standards-compliance-check.skill`](per-skill/skill/standards-compliance-check.skill) | [`standards-compliance-check.zip`](per-skill/zip/standards-compliance-check.zip) |
|
| `standards-compliance-check` | Engineering standards and compliance guidance for mechanical products. | [`standards-compliance-check/SKILL.md`](../skill/standards-compliance-check/SKILL.md) | [`.skill`](per-skill/skill/standards-compliance-check.skill) / [`.zip`](per-skill/zip/standards-compliance-check.zip) | [`standards-compliance-check.md`](upload-md/standards-compliance-check.md) |
|
||||||
| `structural-analysis` | Solid mechanics analysis for parts and assemblies under static loads. Use this skill whenever the user asks for stress, strain, deflection, stiffness, load paths, or structural adequacy checks for mechanical components, even if geometry is incomplete. | [`structural-analysis/SKILL.md`](../skill/structural-analysis/SKILL.md) | [`structural-analysis.md`](upload-md/structural-analysis.md) | [`structural-analysis.skill`](per-skill/skill/structural-analysis.skill) | [`structural-analysis.zip`](per-skill/zip/structural-analysis.zip) |
|
| `structural-analysis` | Solid mechanics analysis for parts and assemblies under static loads. | [`structural-analysis/SKILL.md`](../skill/structural-analysis/SKILL.md) | [`.skill`](per-skill/skill/structural-analysis.skill) / [`.zip`](per-skill/zip/structural-analysis.zip) | [`structural-analysis.md`](upload-md/structural-analysis.md) |
|
||||||
| `technical-report` | Technical report writing for mechanical engineering deliverables. Use this skill whenever the user needs a clear, professional engineering report with rationale, findings, and recommendations for stakeholders. | [`technical-report/SKILL.md`](../skill/technical-report/SKILL.md) | [`technical-report.md`](upload-md/technical-report.md) | [`technical-report.skill`](per-skill/skill/technical-report.skill) | [`technical-report.zip`](per-skill/zip/technical-report.zip) |
|
| `technical-report` | Technical report writing for mechanical engineering deliverables. | [`technical-report/SKILL.md`](../skill/technical-report/SKILL.md) | [`.skill`](per-skill/skill/technical-report.skill) / [`.zip`](per-skill/zip/technical-report.zip) | [`technical-report.md`](upload-md/technical-report.md) |
|
||||||
| `test-plan-validation` | Test planning and validation strategy for mechanical design verification. Use this skill whenever the user asks how to verify requirements, design tests, set acceptance criteria, or plan DV/PV campaigns. | [`test-plan-validation/SKILL.md`](../skill/test-plan-validation/SKILL.md) | [`test-plan-validation.md`](upload-md/test-plan-validation.md) | [`test-plan-validation.skill`](per-skill/skill/test-plan-validation.skill) | [`test-plan-validation.zip`](per-skill/zip/test-plan-validation.zip) |
|
| `test-plan-validation` | Test planning and validation strategy for mechanical design verification. | [`test-plan-validation/SKILL.md`](../skill/test-plan-validation/SKILL.md) | [`.skill`](per-skill/skill/test-plan-validation.skill) / [`.zip`](per-skill/zip/test-plan-validation.zip) | [`test-plan-validation.md`](upload-md/test-plan-validation.md) |
|
||||||
| `thermal-analysis` | Thermal behavior analysis for mechanical systems. Use this skill whenever the user asks about temperatures, heat flux, thermal gradients, cooling, insulation, or thermal sizing of components and assemblies. | [`thermal-analysis/SKILL.md`](../skill/thermal-analysis/SKILL.md) | [`thermal-analysis.md`](upload-md/thermal-analysis.md) | [`thermal-analysis.skill`](per-skill/skill/thermal-analysis.skill) | [`thermal-analysis.zip`](per-skill/zip/thermal-analysis.zip) |
|
| `thermal-analysis` | Thermal behavior analysis for mechanical systems. | [`thermal-analysis/SKILL.md`](../skill/thermal-analysis/SKILL.md) | [`.skill`](per-skill/skill/thermal-analysis.skill) / [`.zip`](per-skill/zip/thermal-analysis.zip) | [`thermal-analysis.md`](upload-md/thermal-analysis.md) |
|
||||||
| `thermal-expansion-stress` | Thermal expansion mismatch and thermal stress assessment. Use this skill whenever the user asks about differential expansion, constrained thermal growth, thermal bowing, or seal/interface thermal issues. | [`thermal-expansion-stress/SKILL.md`](../skill/thermal-expansion-stress/SKILL.md) | [`thermal-expansion-stress.md`](upload-md/thermal-expansion-stress.md) | [`thermal-expansion-stress.skill`](per-skill/skill/thermal-expansion-stress.skill) | [`thermal-expansion-stress.zip`](per-skill/zip/thermal-expansion-stress.zip) |
|
| `thermal-expansion-stress` | Thermal expansion mismatch and thermal stress assessment. | [`thermal-expansion-stress/SKILL.md`](../skill/thermal-expansion-stress/SKILL.md) | [`.skill`](per-skill/skill/thermal-expansion-stress.skill) / [`.zip`](per-skill/zip/thermal-expansion-stress.zip) | [`thermal-expansion-stress.md`](upload-md/thermal-expansion-stress.md) |
|
||||||
| `tolerance-gdt-fits` | Tolerance stack-up, GD&T, and fit selection for assemblies. Use this skill whenever the user asks about dimensional variation, datums, interchangeability, fit class, or functional tolerancing. | [`tolerance-gdt-fits/SKILL.md`](../skill/tolerance-gdt-fits/SKILL.md) | [`tolerance-gdt-fits.md`](upload-md/tolerance-gdt-fits.md) | [`tolerance-gdt-fits.skill`](per-skill/skill/tolerance-gdt-fits.skill) | [`tolerance-gdt-fits.zip`](per-skill/zip/tolerance-gdt-fits.zip) |
|
| `tolerance-gdt-fits` | Tolerance stack-up, GD&T, and fit selection for assemblies. | [`tolerance-gdt-fits/SKILL.md`](../skill/tolerance-gdt-fits/SKILL.md) | [`.skill`](per-skill/skill/tolerance-gdt-fits.skill) / [`.zip`](per-skill/zip/tolerance-gdt-fits.zip) | [`tolerance-gdt-fits.md`](upload-md/tolerance-gdt-fits.md) |
|
||||||
| `tribology-lubrication` | Tribology and lubrication engineering for moving interfaces. Use this skill whenever the user asks about friction, wear, lubrication regime, lubricant choice, surface finish, or seizure/scuffing risk. | [`tribology-lubrication/SKILL.md`](../skill/tribology-lubrication/SKILL.md) | [`tribology-lubrication.md`](upload-md/tribology-lubrication.md) | [`tribology-lubrication.skill`](per-skill/skill/tribology-lubrication.skill) | [`tribology-lubrication.zip`](per-skill/zip/tribology-lubrication.zip) |
|
| `tribology-lubrication` | Tribology and lubrication engineering for moving interfaces. | [`tribology-lubrication/SKILL.md`](../skill/tribology-lubrication/SKILL.md) | [`.skill`](per-skill/skill/tribology-lubrication.skill) / [`.zip`](per-skill/zip/tribology-lubrication.zip) | [`tribology-lubrication.md`](upload-md/tribology-lubrication.md) |
|
||||||
|
|
||||||
## Validation
|
## Validation Checks
|
||||||
- [x] package count check: expected 68, found 68
|
- [x] package count check: expected 68, found 68
|
||||||
- [x] bearings-seals-selection.skill: OK
|
- [x] bearings-seals-selection.skill: OK
|
||||||
- [x] bearings-seals-selection.zip: OK
|
- [x] bearings-seals-selection.zip: OK
|
||||||
|
|||||||
@@ -130,7 +130,6 @@ def validate_bundle_contains_skills(bundle_path: Path, source_dir_names: list[st
|
|||||||
|
|
||||||
def build_index(
|
def build_index(
|
||||||
output_file: Path,
|
output_file: Path,
|
||||||
skills_root: Path,
|
|
||||||
valid_skills: list[SkillRecord],
|
valid_skills: list[SkillRecord],
|
||||||
skipped: list[str],
|
skipped: list[str],
|
||||||
warnings: list[str],
|
warnings: list[str],
|
||||||
@@ -140,22 +139,40 @@ def build_index(
|
|||||||
def table_safe(value: str) -> str:
|
def table_safe(value: str) -> str:
|
||||||
return value.replace("|", r"\|").replace("\n", " ").strip()
|
return value.replace("|", r"\|").replace("\n", " ").strip()
|
||||||
|
|
||||||
|
def concise_scope(value: str, max_len: int = 120) -> str:
|
||||||
|
cleaned = " ".join(value.split()).strip()
|
||||||
|
if not cleaned:
|
||||||
|
return "N/A"
|
||||||
|
|
||||||
|
parts = cleaned.split(". ", 1)
|
||||||
|
scope = parts[0].strip()
|
||||||
|
if len(parts) > 1 and not scope.endswith("."):
|
||||||
|
scope = f"{scope}."
|
||||||
|
|
||||||
|
if len(scope) > max_len:
|
||||||
|
scope = scope[: max_len - 3].rstrip() + "..."
|
||||||
|
|
||||||
|
return table_safe(scope)
|
||||||
|
|
||||||
ts = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S UTC")
|
ts = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S UTC")
|
||||||
all_ok = all(ok for ok, _ in validations)
|
all_ok = all(ok for ok, _ in validations)
|
||||||
|
passed_validations = sum(1 for ok, _ in validations if ok)
|
||||||
|
total_validations = len(validations)
|
||||||
package_dir = output_file.parent
|
package_dir = output_file.parent
|
||||||
upload_md_dir = package_dir / "upload-md"
|
upload_md_dir = package_dir / "upload-md"
|
||||||
|
|
||||||
lines = [
|
lines = [
|
||||||
"# Packages Index",
|
"# Mechanical Skills Packages Index",
|
||||||
"",
|
"",
|
||||||
"## Snapshot",
|
"## Snapshot",
|
||||||
"",
|
"",
|
||||||
f"- Generated (UTC): **{ts}**",
|
"| Item | Value |",
|
||||||
f"- Skills root: `{skills_root}`",
|
"| --- | --- |",
|
||||||
f"- Valid skills packaged: **{len(valid_skills)}**",
|
f"| Generated (UTC) | `{ts}` |",
|
||||||
"- Per-skill formats: `.skill` and `.zip` in separate folders",
|
f"| Valid skills packaged | **{len(valid_skills)}** |",
|
||||||
f"- Bundle: [`{bundle_path.name}`](bundles/{bundle_path.name})",
|
"| Per-skill formats | `.skill` and `.zip` (separate folders) |",
|
||||||
f"- Validation status: **{'PASS' if all_ok else 'FAIL'}**",
|
f"| Bundle | [`{bundle_path.name}`](bundles/{bundle_path.name}) |",
|
||||||
|
f"| Validation status | **{'PASS' if all_ok else 'FAIL'}** ({passed_validations}/{total_validations}) |",
|
||||||
"",
|
"",
|
||||||
"## Quick Links",
|
"## Quick Links",
|
||||||
"",
|
"",
|
||||||
@@ -168,8 +185,8 @@ def build_index(
|
|||||||
"",
|
"",
|
||||||
"## Skill Catalog",
|
"## Skill Catalog",
|
||||||
"",
|
"",
|
||||||
"| Skill | Description | Source | Markdown | .skill | .zip |",
|
"| Skill | Scope | Source | Packages | Markdown |",
|
||||||
"| --- | --- | --- | --- | --- | --- |",
|
"| --- | --- | --- | --- | --- |",
|
||||||
]
|
]
|
||||||
|
|
||||||
for skill in sorted(valid_skills, key=lambda item: item.package_name):
|
for skill in sorted(valid_skills, key=lambda item: item.package_name):
|
||||||
@@ -185,14 +202,14 @@ def build_index(
|
|||||||
)
|
)
|
||||||
source_cell = (
|
source_cell = (
|
||||||
f"[`{skill.source_dir_name}/SKILL.md`]({source_rel})"
|
f"[`{skill.source_dir_name}/SKILL.md`]({source_rel})"
|
||||||
if Path(skills_root / skill.source_dir_name / "SKILL.md").exists()
|
if (skill.source_path / "SKILL.md").exists()
|
||||||
else "N/A"
|
else "N/A"
|
||||||
)
|
)
|
||||||
|
|
||||||
lines.append(
|
lines.append(
|
||||||
"| `{name}` | {description} | {source} | {markdown} | [`{name}.skill`]({skill_pkg}) | [`{name}.zip`]({zip_pkg}) |".format(
|
"| `{name}` | {scope} | {source} | [`.skill`]({skill_pkg}) / [`.zip`]({zip_pkg}) | {markdown} |".format(
|
||||||
name=skill.package_name,
|
name=skill.package_name,
|
||||||
description=table_safe(skill.description),
|
scope=concise_scope(skill.description),
|
||||||
source=source_cell,
|
source=source_cell,
|
||||||
markdown=markdown_cell,
|
markdown=markdown_cell,
|
||||||
skill_pkg=skill_rel,
|
skill_pkg=skill_rel,
|
||||||
@@ -200,7 +217,7 @@ def build_index(
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
lines.extend(["", "## Validation"])
|
lines.extend(["", "## Validation Checks"])
|
||||||
lines.extend(
|
lines.extend(
|
||||||
[f"- [{'x' if ok else ' '}] {message}" for ok, message in validations]
|
[f"- [{'x' if ok else ' '}] {message}" for ok, message in validations]
|
||||||
)
|
)
|
||||||
@@ -314,7 +331,6 @@ def package_skills(skills_root: Path, output_dir: Path, bundle_name: str, spot_c
|
|||||||
index_path = output_dir / "PACKAGES_INDEX.md"
|
index_path = output_dir / "PACKAGES_INDEX.md"
|
||||||
build_index(
|
build_index(
|
||||||
output_file=index_path,
|
output_file=index_path,
|
||||||
skills_root=skills_root,
|
|
||||||
valid_skills=valid_skills,
|
valid_skills=valid_skills,
|
||||||
skipped=skipped,
|
skipped=skipped,
|
||||||
warnings=warnings,
|
warnings=warnings,
|
||||||
|
|||||||
Reference in New Issue
Block a user