From 0a8921064fb1519068df6602eb5c27df9d8e00de Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 16 Jul 2026 08:14:47 +0000 Subject: [PATCH 1/2] docs: document appInfo prop and /__appinfo built-in page Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/api/use-app-shell-config.md | 1 + docs/components/app-shell.md | 33 ++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) diff --git a/docs/api/use-app-shell-config.md b/docs/api/use-app-shell-config.md index 335b7ed7..c7c40549 100644 --- a/docs/api/use-app-shell-config.md +++ b/docs/api/use-app-shell-config.md @@ -22,6 +22,7 @@ const useAppShellConfig: () => AppShellConfig; | `basePath` | `string \| undefined` | Base path for all routes | | `modules` | `Module[]` | Registered modules | | `settingsResources` | `Resource[]` | Resources that appear only in Settings menu | +| `appInfo` | `AppInfo \| undefined` | Configuration for the built-in `/__appinfo` page | ## Usage diff --git a/docs/components/app-shell.md b/docs/components/app-shell.md index bff523b3..26b6a248 100644 --- a/docs/components/app-shell.md +++ b/docs/components/app-shell.md @@ -346,6 +346,39 @@ See [`SearchSource`](./command-palette.md#searchsource) for the full type refere > **Note:** `DefaultSidebar` always renders a **Search** entry that opens the palette regardless of whether `searchSources` is configured. The `Cmd+K` / `Ctrl+K` shortcut also works globally. +### appInfo + +- **Type:** `AppInfo` (optional) +- **Description:** Configuration for the built-in `/__appinfo` page, which exposes app metadata and the current AppShell version. The page is excluded from sidebar navigation but appears in the Command Palette as a page entry and includes a copy button for the rendered information. + +`AppInfo` has the following shape: + +| Property | Type | Description | +| ---------- | --------------------------- | ---------------------------------------------------- | +| `metadata` | `readonly AppInfoEntry[]` | Additional rows shown on the `/__appinfo` page | + +Each `AppInfoEntry` has: + +| Property | Type | Description | +| -------- | --------------------------------------------- | -------------------------------------------------- | +| `label` | `string` | Display label shown on the page | +| `value` | `string \| number \| boolean \| null \| undefined` | Value rendered as text | + +```tsx + + {/* ... */} + +``` + ### children - **Type:** `React.ReactNode` (required) From a857fa6a5314797b14070744dc2ea48d37587488 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 22 Jul 2026 04:06:32 +0000 Subject: [PATCH 2/2] fix: fix formatting issues in docs files Co-authored-by: IzumiSy <982850+IzumiSy@users.noreply.github.com> --- docs/api/use-app-shell-config.md | 14 +++++++------- docs/components/app-shell.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/api/use-app-shell-config.md b/docs/api/use-app-shell-config.md index c7c40549..194e1477 100644 --- a/docs/api/use-app-shell-config.md +++ b/docs/api/use-app-shell-config.md @@ -15,13 +15,13 @@ const useAppShellConfig: () => AppShellConfig; ## Return Value -| Property | Type | Description | -| ------------------- | ------------------------------ | ------------------------------------------- | -| `title` | `string \| undefined` | App title | -| `icon` | `React.ReactNode \| undefined` | App icon | -| `basePath` | `string \| undefined` | Base path for all routes | -| `modules` | `Module[]` | Registered modules | -| `settingsResources` | `Resource[]` | Resources that appear only in Settings menu | +| Property | Type | Description | +| ------------------- | ------------------------------ | ------------------------------------------------ | +| `title` | `string \| undefined` | App title | +| `icon` | `React.ReactNode \| undefined` | App icon | +| `basePath` | `string \| undefined` | Base path for all routes | +| `modules` | `Module[]` | Registered modules | +| `settingsResources` | `Resource[]` | Resources that appear only in Settings menu | | `appInfo` | `AppInfo \| undefined` | Configuration for the built-in `/__appinfo` page | ## Usage diff --git a/docs/components/app-shell.md b/docs/components/app-shell.md index 26b6a248..24f91763 100644 --- a/docs/components/app-shell.md +++ b/docs/components/app-shell.md @@ -353,16 +353,16 @@ See [`SearchSource`](./command-palette.md#searchsource) for the full type refere `AppInfo` has the following shape: -| Property | Type | Description | -| ---------- | --------------------------- | ---------------------------------------------------- | -| `metadata` | `readonly AppInfoEntry[]` | Additional rows shown on the `/__appinfo` page | +| Property | Type | Description | +| ---------- | ------------------------- | ---------------------------------------------- | +| `metadata` | `readonly AppInfoEntry[]` | Additional rows shown on the `/__appinfo` page | Each `AppInfoEntry` has: -| Property | Type | Description | -| -------- | --------------------------------------------- | -------------------------------------------------- | -| `label` | `string` | Display label shown on the page | -| `value` | `string \| number \| boolean \| null \| undefined` | Value rendered as text | +| Property | Type | Description | +| -------- | -------------------------------------------------- | ------------------------------- | +| `label` | `string` | Display label shown on the page | +| `value` | `string \| number \| boolean \| null \| undefined` | Value rendered as text | ```tsx