diff --git a/apps/docs/src/content/roadmap.md b/apps/docs/src/content/roadmap.md new file mode 100644 index 00000000..8be3d670 --- /dev/null +++ b/apps/docs/src/content/roadmap.md @@ -0,0 +1,78 @@ +--- +title: Roadmap +description: What Pangular Inspector covers today and the planned work, in four phases, each tracked in a GitHub issue. +--- + + + What Pangular Inspector covers today, and the planned work in the order it happens. Each phase has a tracking issue with the full checklist. + + +# Roadmap + +The planned work is grouped into four phases. Each phase starts when the one before it is done, and each one has a GitHub issue with the full list of tasks. The tables on this page show the highlights. + +Plans follow feedback. To ask for something, or to move an item up, comment on its issue or [open a feature request](https://github.com/pangular-inspector/devtools/issues). + +## Available today + +| Feature | Read more | +| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| Agent tools over MCP for the live app | [Tools](./agents/tools.md) | +| NgRx and SignalStore time travel | [Restore an earlier state](./inspectors/ngrx-store.md#restore-an-earlier-state) | +| Why a form is invalid, for you and agents | [Forms agent tools](./inspectors/forms.md#agent-tools) | +| Mobile apps | [Capacitor](./inspectors/capacitor.md), [NativeScript](./getting-started/nativescript.md), [Angular Native](./getting-started/angular-native.md) | + +## Phase 1: wired into your workflow + +Tracked in [#340](https://github.com/pangular-inspector/devtools/issues/340). + +| Item | What it does | +| ----------------------- | ------------------------------------------------------------------------------------------------ | +| Open in editor | Alt+click a component on the page, or any file and line in the panel, to open it in your editor. | +| One-line Vite setup | The Vite plugin adds the overlay to the page, so setup is one line in `vite.config.ts`. | +| One-command agent setup | One command prints the MCP config for Claude Code and other agents. | +| Safe by default | The hub stays off in production builds and checks every request by default. | + +## Phase 2: deeper inspection + +Tracked in [#341](https://github.com/pangular-inspector/devtools/issues/341). + +| Item | What it does | +| ----------------------- | ----------------------------------------------------------------------------------------------------- | +| Edit inputs and signals | Change inputs, properties and writable signals from the panel and from agents. | +| Change detection flash | Components flash on the page as change detection checks them. | +| Flame graph | A flame graph and a per-cycle chart for change detection recordings, plus a Chrome Performance track. | +| Hydration overlay | Hydrated, skipped and mismatched regions marked on the page. | + +## Phase 3: a shell you live in + +Tracked in [#342](https://github.com/pangular-inspector/devtools/issues/342). Ionic support is tracked in [#307](https://github.com/pangular-inspector/devtools/issues/307). + +| Item | What it does | +| ----------------------- | ------------------------------------------------------------------------------ | +| Command palette | ⌘K or Ctrl+K opens any tab or action. | +| NG0xxx errors explained | Runtime errors with their code, a docs link and the component that threw them. | +| `ng add` | One command sets up the overlay and the hub in an Angular CLI app. | +| Ionic support | Ionic apps, on top of the Capacitor support. | + +## Phase 4: deeper diagnosis + +Tracked in [#343](https://github.com/pangular-inspector/devtools/issues/343). + +| Item | What it does | +| ------------------------- | ------------------------------------------------------------------------------------------------------ | +| What triggered each check | For zoneless apps, the event, signal, timer or request behind each run. | +| Leak detection | Live subscriptions and effects per component, and components that stay alive after they are destroyed. | +| WebMCP tools | Read-only tools registered on the page for browser agents. | + +## Fixes and improvements per inspector + +Besides the phases, issues [#344](https://github.com/pangular-inspector/devtools/issues/344) through [#359](https://github.com/pangular-inspector/devtools/issues/359) track inspector and package audit findings and proposed improvements. Pull requests for any of them are welcome. Start with [Development setup](./contributing/development.md). + +## Where to next + + + + + + diff --git a/apps/docs/src/ngmd.config.ts b/apps/docs/src/ngmd.config.ts index 8b28f0b3..c2bb4570 100644 --- a/apps/docs/src/ngmd.config.ts +++ b/apps/docs/src/ngmd.config.ts @@ -231,6 +231,7 @@ const config: NgmdConfig = { label: 'Community', items: [ {label: 'Get involved', href: '/community'}, + {label: 'Roadmap', href: '/roadmap', status: 'new'}, {label: 'Sponsors', href: '/sponsors'}, {label: 'Press kit', href: '/press-kit'}, ],