Repository navigation
docs: fix and improve the docs site from the October 2026 audit #335
Copy link
Copy link
Closed as duplicate
Labels
bugSomething is broken or shows wrong dataSomething is broken or shows wrong datafeatureA feature request or a pull request that adds oneA feature request or a pull request that adds one
Description
Context
This comes from a code audit of the docs site (apps/docs), done during a comparison with Nuxt, Vue and Vite DevTools in October 2026. Roadmap items live in #310, #311, #312 and #313. Items marked (to confirm) were not reproduced; every item below was checked against current main.
Problems
Medium
- Setup and guide pages repeat each other: NativeScript, Angular Native and Analog each have a Getting Started page and a Guides page with near-identical descriptions, so they will drift and readers don't know which one to follow. Merge each pair into one page, or turn the Getting Started page into a short pointer to the guide (
apps/docs/src/content/getting-started/nativescript.mdvsguides/nativescript.md,getting-started/angular-native.mdvsguides/angular-native.md,getting-started/vite.mdvsguides/analog.md). - No API reference:
api-gen.plugin.tsis a no-op becauseapps/docs/ngmd.api.tsdoes not exist, and per-symbol routes are "not yet wired".initPangularHub,pangular(),createPangular, the overlay and popup entry points and the HTTP interceptor are only described in prose. Addngmd.api.tsscoped topackages/devtools/src/{hub,vite,devframe,config,overlay,popup,http}.tsand finish the per-symbol routes so the JSDoc onPangularConfigfeeds the docs (apps/docs/api-gen.plugin.ts:7-24). - Troubleshooting is scattered: only Express, Hono/h3/Fastify and Popup and hub have a Troubleshooting section. Vite/Analog, the CLI, MCP and the Chrome extension have none. Add one troubleshooting page indexed by symptom (no page connected, empty tab in a production build, one-time code prompt, port taken) and link it from every Getting Started page and from the panel empty states (
getting-started/express.md:256,getting-started/popup-and-hub.md:175,getting-started/other-servers.md:119).
Low
- Sidebar badges mean nothing: 13 nav items carry
status: 'new'or'updated'and nothing ever removes them. Tie each badge to a package version and expire it after the next minor release (apps/docs/src/ngmd.config.ts:180-209). - CLI help spells the flag wrong: the
--forcedescription says--out-dir, while the errors and the CLI page use--outDir. Change the text to--outDir(packages/devtools/src/cli.ts:62,getting-started/cli.md:141-143). - No page for planned platforms: Capacitor is a Coming Soon view in the panel with plans and PR links, but the docs only mention it in one table row. Add a short Platforms page listing supported and planned targets with their tracking issues, and link it from the coming-soon view (
app/src/app.ts:68-72,app/src/pages/coming-soon.ts,getting-started/popup-and-hub.md:122).
Improvements
- A Features overview page that walks every tab with a screenshot and a one-line use case, linking to the inspector page (
getting-started/introduction.md). - A Comparisons page against Nuxt, Vue and Vite DevTools: what we share (devframe base, in-page popup, MCP) and what is Angular-specific (DI tree, hydration and TransferState, Signal Forms) (new page,
ngmd.config.ts). - Publish
/llms.txt(andllms-full.txt) built from the content files; the raw.mdroutes already exist (apps/docs/raw-md.plugin.ts). - Short GIF or video clips for interactive flows: pick a component, router probe, HTTP fault injection, NgRx restore (
inspectors/*.md,<ngmd-video>). - Generate the agent tools reference from the tool registrations so ids and parameters can't drift, and add a CI check that every
pangular:*id has a heading (packages/devtools/src/devframe.ts,packages/devtools/src/rpc/,agents/tools.md). - A "Recipes for agents" page with end-to-end prompts for Claude Code, Cursor and Copilot (debug an invalid form, explain a failed navigation, find a missing provider) (
agents/). - A keyboard shortcuts reference; shortcuts are spread over
inspectors/components.md,inspectors/injectors.mdandgetting-started/popup-and-hub.md. - A version matrix tying each feature to its minimum Angular version (signal graph 20.1, router probe 20.2, Signal Forms 22) (
getting-started/installation.md:32).
Already tracked elsewhere
- Screenshots on every inspector page: phase 3 of 4: a devframe shell as good as Vue and Nuxt DevTools #312.
- A one-path quick start: phase 3 of 4: a devframe shell as good as Vue and Nuxt DevTools #312.
- An "Angular DevTools vs Pangular Inspector" FAQ entry: phase 3 of 4: a devframe shell as good as Vue and Nuxt DevTools #312.
- An "Extending Pangular Inspector" page depends on the public plugin API in phase 4 of 4: lead where no Angular devtools goes today #313.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething is broken or shows wrong dataSomething is broken or shows wrong datafeatureA feature request or a pull request that adds oneA feature request or a pull request that adds one
Activity