Skip to content

Open source

MIT licensed. The rules live in the scanner, and the docs describe the package you run.

License

Angular Doctor is released under the MIT license. You can use it, change it, and ship it with your own tools, as long as the license notice stays with the code.

Where rules live

Rules live in the scanner. A new check needs a stable id, a severity, and a short message that says what to do next. Docs on this site describe the package a user runs, not the layout of the repository.

This site

The site is built with Analog and Angular. The source is on GitHub, under the MIT license. Angie, the Angular mascot, appears on the 404 page.

Deploy

The site deploys as static files on Cloudflare Workers. Every route is prerendered, so no server is needed. wrangler.jsonc at the repository root publishes apps/docs/dist/analog/public.

  • Root directory: /
  • Build command: pnpm docs:build
  • Deploy command: npx wrangler deploy
  • Node version: 20.19 or newer

When a docs page is added under src/app/pages, add its route to the prerender list in apps/docs/vite.config.ts, or it will not exist in the static output.

The mark is not the Angular shield

The brand mark on this site is a scan trace, not the Angular shield. Angie is used only on the 404 page, with the supplied artwork.