Skip to content

Commit

Permalink
feat(Style guide): Add hidden comment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rhetoric101 committed Jun 22, 2023
1 parent e5b69ca commit dbe572e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/content/docs/style-guide/structure/hidden-comments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Comments
tags:
- Basic style guide
- Style guide quick reference
---

Sometimes you need to catch the attention of your fellow writers or contributors, alerting them about some aspect of the MDX documentation files before they make changes. You can do this by inserting a comment with the `<CONTRIBUTOR_NOTE>` component.

Here are just two examples of where you might use this component:

* Warn others about making changes to sensitive information on the site.
* Explain the rationale for why information exists where it is on the site.

When you use the `<CONTRIBUTOR_NOTE>` component to compose notes, those notes will never get converted to HTML and will never be seen by our readers directly on the website (including in **View source**). However, they are available to those who choose to edit the site, so always consider your voice and tone.

Here's an example:

```
<CONTRIBUTOR_NOTE>
Do not change this URL unless you have explicit permission from a manager at New Relic.
</CONTRIBUTOR_NOTE>
```
2 changes: 2 additions & 0 deletions src/nav/style-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ pages:
path: /docs/style-guide/structure/intro-to-components
- title: Collapsers
path: /docs/style-guide/structure/collapsers
- title: Comments
path: /docs/style-guide/structure/hidden-comments
- title: Heading levels
path: /docs/style-guide/structure/levels-headings
- title: Indentation
Expand Down

0 comments on commit dbe572e

Please sign in to comment.