Files
angular__angular/adev
Alan Agius 8e48bc9a82 docs(docs-infra): add support for @example (#60443)
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@example` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package.

This change ensures that `@example` is treated the same as `@usageNotes` during the transform process and also handle multiple instances of `@example` on the same tag.

PR Close #60443
2025-03-18 18:14:10 +01:00
..

Angular.dev

This site is built with Angular.

The content is written primarily in Markdown format located in src/content. For simple edits, you can directly edit the file on GitHub and generate a Pull Request.

Local Development

For local development, yarn is the preferred package manager. You can set up a local environment with the following commands :

# Clone Angular repo
git clone https://github.com/angular/angular.git

# Navigate to project directory
cd angular

# Install dependencies
yarn

# Build and run local dev server
# Note: Initial build will take some time
yarn docs

If you are having issues with the docs building, see the FAQs section.

Contributing

Want to report a bug, contribute some code, or improve the documentation? Excellent!

Read through our contributing guidelines to learn about our submission process, coding rules, and more.

And if you're new, check out one of our issues labeled as help wanted or good first issue.

Code of Conduct

Help us keep Angular open and inclusive. Please read and follow our Code of Conduct.

FAQs

The build is failing and I'm seeing bazel:bazel failed: missing input file messages.

This is most likely due to a bazel dependency / caching issue. To resolve this, run the following command:

# Try this first
yarn bazel clean

# If that doesn't work, try it with the expunge flag
yarn bazel clean --expunge