Skip to content

Commit 47a1be8

Browse files
JasonVMoCopilot
andauthored
docs(desktop): restructure package status docs into topic sections (#4507)
Replace the append-only dated logs in the current-status references of desktop-test, desktop-driver, desktop-driver-mcp and storybook-desktop with a status overview followed by stable topic sections, so changes to different topics merge cleanly. Each native endpoint keeps only its latest result with a link to the pull request or issue that holds the full evidence, and open work links to its tracking issue instead of restating it. - Add R-PKGDOC-010 describing the format. - Update README, reference-index and cross-reference wording and anchors. - Preserve the macOS activation source trace in the driver remaining-work plan. - Add a changeset. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 03bf8ad5-441c-41df-9738-791afdcbb6b5
1 parent 49216e3 commit 47a1be8

17 files changed

Lines changed: 1218 additions & 8356 deletions

File tree

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
"@fluentui-react-native/desktop-driver": patch
3+
"@fluentui-react-native/desktop-driver-mcp": patch
4+
"@fluentui-react-native/desktop-test": patch
5+
"@fluentui-react-native/storybook-desktop": patch
6+
---
7+
8+
Restructure each package's current-status reference from a dated running log into a status overview with stable topic sections and the latest result per native endpoint. Per-run evidence now lives in pull request descriptions and issues, and remaining-work detail lives in the linked tracking issues.

‎packages/agentic/desktop-driver-mcp/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ coding agents the Desktop Driver agent operations: bounded observation,
55
element search, actions, checks with waits, captures, and Storybook story
66
selection on a native macOS or Windows application.
77

8-
**Work in progress:** [current status](references/current-status.md) records
9-
implemented connection safeguards, orchestration gaps, native qualification
10-
requirements, and measured MCP discovery costs.
8+
**Work in progress:** [current status](references/current-status.md) summarizes
9+
implemented connection safeguards, open orchestration work, per-endpoint native
10+
qualification, and the latest measured MCP discovery costs.
1111

1212
Agents working in this package start at [AGENTS.md](AGENTS.md).
1313

‎packages/agentic/desktop-driver-mcp/references/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ owner_paths:
77

88
# Desktop Driver MCP references
99

10-
| ID | Document | Read when |
11-
| ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------ |
12-
| `desktop-driver-mcp.connection` | [Connection and setup](connection.md) | Publishing a descriptor, registering the server, or diagnosing connect |
13-
| `desktop-driver-mcp.tools` | [Tools](tools.md) | Calling or changing tools, results, errors, resources, or progress |
14-
| `desktop-driver-mcp.current-status` | [Current status](current-status.md) | Checking implemented lifetime safeguards, native qualification gaps, and measured discovery cost |
10+
| ID | Document | Read when |
11+
| ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------- |
12+
| `desktop-driver-mcp.connection` | [Connection and setup](connection.md) | Publishing a descriptor, registering the server, or diagnosing connect |
13+
| `desktop-driver-mcp.tools` | [Tools](tools.md) | Calling or changing tools, results, errors, resources, or progress |
14+
| `desktop-driver-mcp.current-status` | [Current status](current-status.md) | Checking implemented lifetime safeguards, per-endpoint qualification, and measured discovery cost |

‎packages/agentic/desktop-driver-mcp/references/current-status.md‎

Lines changed: 258 additions & 864 deletions
Large diffs are not rendered by default.

‎packages/agentic/desktop-driver-mcp/references/tools.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ result, and failure reasons are defined once in `@fluentui-react-native/desktop-
1313
service rejects is rejected here first, before anything reaches the service.
1414
Unknown fields are refused. The historical tool list measured about 20.3 KB;
1515
the test bounds serialized JavaScript **characters** at 22,000, not tokens or
16-
UTF-8 bytes. See [measurement history](current-status.md).
16+
UTF-8 bytes. See [measurements](current-status.md#measurements).
1717

1818
| Tool | Calls | Hints |
1919
| ----------------- | ------------------------------------------------------------------- | --------------------------- |

‎packages/agentic/desktop-driver/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ fake hosts for contract tests. It does not depend on Storybook, React, or React
1313
Native.
1414

1515
**Work in progress:** see [current status](references/current-status.md) for
16-
implemented capabilities, incomplete lifecycle guarantees, endpoint qualification,
17-
and measured token/latency history.
16+
implemented capabilities, incomplete lifecycle guarantees, the latest
17+
per-endpoint qualification results, and measured token/latency results.
1818

1919
Story providers use the existing `/storybook` subpath for `StoryProviderContext`,
2020
`StoryBridgeUnavailableError`, and the versioned marker verifier. Built-in routes
@@ -35,7 +35,7 @@ a new verified selection; finding fresh elements alone cannot restore readiness.
3535

3636
V1 permits one active WebDriver session per registered target in one service.
3737
Native helpers also exclude controlling the same exact application incarnation
38-
across services; endpoint qualification and recovery limits are recorded in
38+
across services; endpoint qualification and recovery limits are summarized in
3939
[current status](references/current-status.md). Native builds run only on the
4040
target operating system. Installation never compiles or downloads a helper.
4141

‎packages/agentic/desktop-driver/references/README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ owner_paths:
99

1010
Start with [current status](current-status.md) when assessing readiness.
1111

12-
| ID | Document | Read when |
13-
| --------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------ |
14-
| `desktop-driver.getting-started` | [Getting started](getting-started.md) | Installing, building the package, or first setup |
15-
| `desktop-driver.architecture` | [Architecture](architecture.md) | Choosing a module boundary or tracing ownership |
16-
| `desktop-driver.service` | [Service integration](service.md) | Embedding the WebDriver service or registering targets |
17-
| `desktop-driver.native-helpers` | [Native helpers](native-helpers.md) | Building or resolving native helpers |
18-
| `desktop-driver.test-integration` | [Test integration](test-integration.md) | Connecting WDIO or using driver testing APIs |
19-
| `desktop-driver.ci-integration` | [CI integration](ci-integration.md) | Provisioning helpers and validating CI lanes |
20-
| `desktop-driver.security` | [Security model](security.md) | Reviewing target trust, ownership, or evidence boundaries |
21-
| `desktop-driver.protocol` | [WebDriver contract](protocol.md) | Changing or consuming WebDriver behavior |
22-
| `desktop-driver.operations` | [Agent operations](operations.md) | Calling or changing observe, find, journal, refs, or budgets |
23-
| `desktop-driver.contributing` | [Contributor reference](contributing.md) | Changing package source, tests, or build tooling |
24-
| `desktop-driver.remaining-work` | [Agent efficiency plan](remaining-work.md) | Implementing MCP-first agent workflows and macOS/Windows parity |
25-
| `desktop-driver.current-status` | [Current status](current-status.md) | Checking implemented capabilities, qualification gaps, and measurement history |
12+
| ID | Document | Read when |
13+
| --------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------ |
14+
| `desktop-driver.getting-started` | [Getting started](getting-started.md) | Installing, building the package, or first setup |
15+
| `desktop-driver.architecture` | [Architecture](architecture.md) | Choosing a module boundary or tracing ownership |
16+
| `desktop-driver.service` | [Service integration](service.md) | Embedding the WebDriver service or registering targets |
17+
| `desktop-driver.native-helpers` | [Native helpers](native-helpers.md) | Building or resolving native helpers |
18+
| `desktop-driver.test-integration` | [Test integration](test-integration.md) | Connecting WDIO or using driver testing APIs |
19+
| `desktop-driver.ci-integration` | [CI integration](ci-integration.md) | Provisioning helpers and validating CI lanes |
20+
| `desktop-driver.security` | [Security model](security.md) | Reviewing target trust, ownership, or evidence boundaries |
21+
| `desktop-driver.protocol` | [WebDriver contract](protocol.md) | Changing or consuming WebDriver behavior |
22+
| `desktop-driver.operations` | [Agent operations](operations.md) | Calling or changing observe, find, journal, refs, or budgets |
23+
| `desktop-driver.contributing` | [Contributor reference](contributing.md) | Changing package source, tests, or build tooling |
24+
| `desktop-driver.remaining-work` | [Agent efficiency plan](remaining-work.md) | Implementing MCP-first agent workflows and macOS/Windows parity |
25+
| `desktop-driver.current-status` | [Current status](current-status.md) | Checking implemented capabilities, per-endpoint qualification, open work, and measurements |

0 commit comments

Comments
 (0)