Skip to content

[docs-update] Update docs for appInfo prop and built-in /__appinfo page #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[docs-update] Update docs for appInfo prop and built-in /__appinfo page #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/use-app-shell-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
33 changes: 33 additions & 0 deletions docs/components/app-shell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<AppShell
title="My App"
appInfo={{
metadata: [
{ label: "Environment", value: "staging" },
{ label: "Release", value: "2026.07.16" },
],
}}
modules={modules}
>
{/* ... */}
</AppShell>
```

### children

- **Type:** `React.ReactNode` (required)
Expand Down