1.7 KiB
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 table of contents, also known as the left navigation
- Using the search box on Angular.io
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.
To update search keywords:
-
Navigate to the topic to which you want to update search keywords.
-
Decide what search keywords you'd like to add to the topic. For information on how to format keywords, see Search keywords format.
-
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.
{@a format}
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. For example:
{@searchKeywords route router routing navigation}