You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Publish docs/guide as GitHub Pages with MkDocs Material (#402)
Add the MkDocs + GitHub Actions pipeline to publish docs/guide as a
browsable site at https://microsoft.github.io/microsoft-ui-reactor/.
Compiler:
- DocAssembler.Assemble now takes the page's topicId so screenshot://
refs in subdir pages (recipes/*) emit correct ../images/ paths.
- The compiler also writes README.md alongside index.md so GitHub's
directory browser renders the landing page at docs/guide/.
Template fixes (for both raw GitHub MD viewing and the MkDocs site):
- Convert out-of-tree refs (../specs/*, ../contributing/*,
../reference/async-system.md, _pipeline/ai-author-skill.md) to
absolute https://github.com/microsoft/microsoft-ui-reactor/blob/main/
URLs so links work after docs/guide is published as a standalone
site.
- Redirect stale async-resources-cookbook.md references to
async-resources.md (page was renamed per topic table in
docs/_pipeline/ai-author-skill.md).
- Drop the broken reference/elements/index.md link in components.md.dt
(that reference axis category has not been generated yet).
- Rename readme.md.dt -> index.md.dt so the compiled site root URL
resolves, and update the three inbound readme.md links accordingly.
Stale generated output:
- Remove docs/guide/async-resources-cookbook.md (no template; renamed).
Adds:
- mkdocs.yml with Material theme and curated nav matching the readme's
10-section structure.
- docs/requirements.txt pinning mkdocs, mkdocs-material, pymdown.
- .github/workflows/docs.yml building with --strict on push to main
(paths-filtered to docs/guide/**, mkdocs.yml, requirements.txt, the
workflow itself) and deploying via actions/deploy-pages@v4.
After merging, enable Pages in Settings -> Pages -> Source: GitHub
Actions.
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/_pipeline/templates/dev-tooling.md.dt
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ subcommands map one-to-one to the workflows below.
116
116
| `mur pack-local` / `mur clean-local` | Package / clean the local NuGet feed for samples that consume `Microsoft.UI.Reactor` as a package | `mur pack-local` |
117
117
118
118
`mur docs compile` is the workflow you reach for most often. See
The async-resource hooks (`UseResource`, `UseInfiniteResource`,
149
149
`UseMutation`) wrap this pattern correctly — they own the cancellation
150
150
token, marshal completions back to the UI thread, and clean up their
151
-
[`QueryCache`](async-resources-cookbook.md) subscription on unmount.
151
+
[`QueryCache`](async-resources.md) subscription on unmount.
152
152
Reach for them before writing async-effect glue by hand. When you do
153
153
need a raw `UseEffect` for an async operation, the cleanup function
154
154
is your only chance to cancel the in-flight task — capture a
@@ -260,7 +260,7 @@ the next render leaks the resource.
260
260
**Don't await directly in the lambda.** `UseEffect(async () => ...)`
261
261
detaches from the flush ordering; capture a `CancellationTokenSource`,
262
262
kick off a `Task.Run`, and cancel in cleanup. Or use
263
-
[`UseResource`](async-resources-cookbook.md), which already does this.
263
+
[`UseResource`](async-resources.md), which already does this.
264
264
265
265
**Treat the dep array as a value-equality contract.** Records,
266
266
primitives, and stable setter identities are safe. Freshly-allocated
@@ -276,6 +276,6 @@ before my body did?" question.
276
276
277
277
- **[Effects](effects.md)** — Previous: the surface lifecycle of `UseEffect`.
278
278
- **[Reconciliation](reconciliation.md)** — Next: the commit phase that flush runs after.
279
-
- **[Async resources](async-resources-cookbook.md)** — Hooks built on top of this scheduling.
280
-
- **[async-system reference](../reference/async-system.md)** — Deep walk through cache, refcount, and revalidation.
279
+
- **[Async resources](async-resources.md)** — Hooks built on top of this scheduling.
280
+
- **[async-system reference](https://github.com/microsoft/microsoft-ui-reactor/blob/main/docs/reference/async-system.md)** — Deep walk through cache, refcount, and revalidation.
281
281
- **[Threading and dispatch](threading-and-dispatch.md)** — Why effect bodies always run on the UI thread.
0 commit comments