Updating search keywords

In documentation, being able to find the content you need is equally as important as the content itself. In angular.io, users can discover content in several ways, including:

  • Organic search results, such as through google.com
  • The left navigation bar, also known as sidenav
  • Using the search box in the header

You can help improve the documentation experience by adding search keywords to a given topic. Updating search keywords can help bring users to the content they need faster.

Before you begin

You can update search keywords for a topic even if you've never contributed to Angular before. However, you may find it helpful to have the Contributing to Angular guide available if you're filing your first pull request in the repository.

Updating search keywords

To update search keywords:

  1. Navigate to the topic to which you want to update search keywords.

  2. Decide what search keywords you'd like to add to the topic. For information on how to format keywords, see Search keywords format.

  3. Update the @searchKeywords tag, either through the GitHub user interface or through Angular's standard pull request process.

    If a topic does not have a @searchKeywords tag, you can add it to the end of the topic.

Search keywords format

You add search keywords to a topic using the @searchKeywords tag. This tag takes a set of single words, separated by spaces. The tag and the keywords must be enclosed in curly bracket ({ }) characters. For example:

{@searchKeywords route router routing navigation}
Last reviewed on Mon Feb 28 2022

© 2010–2022 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.