Skip to content

Commit 3ea0b1a

Browse files
committed
docs(docs): add a quick start and panel screenshots on every inspector page
Adds a one-path quick start for an Angular CLI app with SSR, first in Getting Started and linked from the home page and README, real panel screenshots on every inspector page plus the command palette and settings pages, and scripts/docs-screenshots.mjs to regenerate them. Refs #342
1 parent 869a7a5 commit 3ea0b1a

43 files changed

Lines changed: 742 additions & 10 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.claude/skills/devtools-docs/SKILL.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ Rules:
109109
- Inside components use HTML (`<code>`, `<strong>`, `<a>`); markdown doesn't render there. Write `@` as `&#64;`.
110110
- Raw HTML external links need `target="_blank" rel="noopener noreferrer"` or the build fails. Markdown links get it automatically.
111111
- `*Angular`, `*Analog`, `*Devframe`, `*NgRx`, `*MCP`, `*Vite` are keyword links (`keywords` in `ngmd.config.ts`). The asterisk is intentional. Never "fix" it.
112+
- Panel screenshots live in `apps/docs/public/images/panel` and come from `node scripts/docs-screenshots.mjs` (`--only <names>` for some, `--list` for the names). Regenerate the ones a panel change affects, and give each `ngmd-image` an `alt` that says what it shows.
112113

113114
## 6. Code samples
114115

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@ npm install -D @pangular-inspector/devtools
2020

2121
An Angular SSR server imports the hub when it starts, so install the package as a dependency there (`npm install @pangular-inspector/devtools`).
2222

23-
Then follow the [installation guide](./apps/docs/src/content/getting-started/installation.md) for your setup: Angular CLI with Express, Vite and Analog, the standalone CLI, [Angular Native](./apps/docs/src/content/guides/angular-native.md), or [Capacitor](./apps/docs/src/content/guides/capacitor.md). For a coding agent, run `npx @pangular-inspector/devtools mcp`.
23+
For an Angular CLI app with SSR, the [quick start](./apps/docs/src/content/getting-started/quick-start.md) takes you from install to a live panel. For other setups, follow the [installation guide](./apps/docs/src/content/getting-started/installation.md): a client-only Angular CLI app, Vite and Analog, the standalone CLI, [Angular Native](./apps/docs/src/content/guides/angular-native.md), or [Capacitor](./apps/docs/src/content/guides/capacitor.md). For a coding agent, run `npx @pangular-inspector/devtools mcp`.
2424

2525
## Documentation
2626

2727
Read the docs at [pangular-inspector.dev](https://pangular-inspector.dev). Their source lives in [`apps/docs`](./apps/docs); run them locally with `pnpm docs:dev`.
2828

29+
- [Quick start](./apps/docs/src/content/getting-started/quick-start.md)
2930
- [Getting started](./apps/docs/src/content/getting-started/introduction.md)
3031
- [Inspectors](./apps/docs/src/content/inspectors/dashboard.md)
3132
- [Agent tools](./apps/docs/src/content/agents/mcp-server.md)
110 KB
Loading
76.6 KB
Loading
147 KB
Loading
136 KB
Loading
120 KB
Loading
141 KB
Loading
93.3 KB
Loading
122 KB
Loading

0 commit comments

Comments
 (0)