Skip to content

Commit c594061

Browse files
Unify Capability and Framework into one spec-and-design model
Document framework as an adjective for a capability whose design composes other capabilities, note the Frameworks section is being absorbed into Capabilities, and regenerate the affected index tables. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent e4a1e87 commit c594061

4 files changed

Lines changed: 27 additions & 10 deletions

File tree

src/docs/Capabilities/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ capability's folder. See the
1212
[Documentation Model](../Ways-of-Working/Documentation-Model.md) for how spec
1313
and design relate and evolve.
1414

15+
A capability whose design **composes other capabilities** is called a
16+
*framework* — an adjective, not a different kind of document. It lives here with
17+
the same spec-and-design shape as any other capability; the standalone
18+
[Frameworks](../Frameworks/index.md) section is being folded into this one.
19+
1520
<!-- INDEX:START -->
1621

1722
| Section | Description |
@@ -20,6 +25,7 @@ and design relate and evolve.
2025
| [Dependency Updates](dependency-updates/index.md) | How a repository's pinned dependencies are kept current and secure through automated, labelled update pull requests. |
2126
| [Merge Automation](merge-automation/index.md) | How a pull request's required status checks become the machine-readable signal that drives automated approval and merge — green merges, red holds, nothing bypasses the gate. |
2227
| [Downstream Release Propagation](downstream-release-propagation/index.md) | How a release in one repository propagates to the repositories that depend on it, via a delegated agent pull request. |
28+
| [Deployment](deployment/index.md) | How a change to managed resources is approved together with its effect and deployed exactly as approved — one spec, one design per deployment platform and service provider. |
2329
| [VS Code Extension Framework](vscode-extension-framework/index.md) | How a VS Code extension is built, tested, versioned, packaged, and published — one GitHub-native pipeline, opt-in from a template and a single settings file. |
2430
| [PowerShell on GitHub](powershell-on-github/index.md) | How we make GitHub a first-class platform for PowerShell through reusable modules, actions, and capability gaps we close over time. |
2531

src/docs/Frameworks/index.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
---
22
title: Frameworks
3-
description: The complete, end-to-end frameworks the ecosystem ships — opinionated automation a project adopts wholesale to go from source to shipped.
3+
description: Frameworks are capabilities whose design composes other capabilities — being absorbed into Capabilities, documented with the same spec and design.
44
---
55

66
# Frameworks
77

8-
The complete, end-to-end frameworks a project adopts wholesale. Where a
9-
[capability](../Capabilities/index.md) is a single independently versioned thing
10-
the ecosystem builds, a framework composes many of them into one opinionated
11-
pipeline that takes a repository from source to shipped with a single
12-
configuration file.
13-
14-
Each framework is documented as its own section — an overview plus the pages that
15-
cover how it works, how to use it, and how to configure it.
8+
A *framework* is a [capability](../Capabilities/index.md) whose design **composes
9+
other capabilities** into one opinionated pipeline that takes a repository from
10+
source to shipped with a single configuration file. "Framework" is an adjective
11+
for that kind of capability, not a separate documentation model: each framework
12+
carries the same **spec** and **design** as any other capability.
13+
14+
This standalone section is being **absorbed into
15+
[Capabilities](../Capabilities/index.md)** — the evidence it should be is already
16+
here: `vscode-extension-framework` lives under Capabilities with a spec and a
17+
design, while the pages below still lack that pair. As each framework gains its
18+
spec and design it moves under Capabilities; until then it is documented as its
19+
own section here.
1620

1721
<!-- INDEX:START -->
1822

src/docs/Ways-of-Working/Documentation-Model.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ user (human or agent) can rely on. It never prescribes implementation. The
2626
mechanism, the moving parts, the configuration. Both are durable, and both
2727
evolve — neither is a one-time plan.
2828

29+
Everything the ecosystem builds is documented this one way — there is no second
30+
shape. A capability whose **design composes other capabilities** is simply called
31+
a *framework*: "framework" is an adjective for that kind of capability, not a
32+
separate section or a different pair of documents. It carries the same spec and
33+
design as any other capability, and lives beside them under
34+
[Capabilities](../Capabilities/index.md).
35+
2936
Only the detail of a *single change* — the paths touched, the trade-off taken
3037
this once — stays out of both, living in the [issue](Issues/Process/Format.md) and the
3138
pull request where it belongs.

src/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Each area below carries its own index. Start here, read the descriptions, and fo
5050
| [Agents](Agents/index.md) | The roles agents play across the ecosystem — authored once as documentation and pointed to from each repository. |
5151
| [Coding Standards](Coding-Standards/index.md) | The shared baseline every repository inherits, and the per-language standards that build on it. |
5252
| [Capabilities](Capabilities/index.md) | The capabilities the ecosystem builds, each documented by a spec (why and what) and a design (how and what). |
53-
| [Frameworks](Frameworks/index.md) | The complete, end-to-end frameworks the ecosystem ships — opinionated automation a project adopts wholesale to go from source to shipped. |
53+
| [Frameworks](Frameworks/index.md) | Frameworks are capabilities whose design composes other capabilities — being absorbed into Capabilities, documented with the same spec and design. |
5454
| [Dictionary](Dictionary/index.md) | Shared vocabulary for the MSX ecosystem — the terms a reader or agent meets across these docs. |
5555

5656
<!-- INDEX:END -->

0 commit comments

Comments
 (0)