diff --git a/aio/content/guide/docs-style-guide.md b/aio/content/guide/docs-style-guide.md index 6b4bd51f8a..021be52185 100644 --- a/aio/content/guide/docs-style-guide.md +++ b/aio/content/guide/docs-style-guide.md @@ -322,6 +322,7 @@ The item property is `true`. For block code snippets, we generally prefer to display code with the Angular documentation _code-example_ component represented by the `` tag. +The `` tag has a `header` attribute that you use to identify the file that the example comes from. The header should be used whenever possible to establish the context of the example. See [Code snippets and code examples](guide/docs-style-guide#code-snippets-and-code-samples) for more details.

Inline code-snippets

@@ -348,6 +349,8 @@ user input in a command shell or the _output_ of some process. **Do not write inline code snippets** unless you have a good reason and the editor's permission to do so. In all other cases, code snippets should be generated automatically from tested code samples. +For hypothetical examples such as illustrations of configuration options in a JSON file, you should still use The `` tag with the `header` attribute to identify the context. + {@a from-code-samples}

Code snippets and code samples