Skip to content

Commit

Permalink
Update how to write headers (#52795)
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanpalm authored Oct 21, 2024
1 parent 2363950 commit c9beaf1
Showing 1 changed file with 56 additions and 4 deletions.
60 changes: 56 additions & 4 deletions content/contributing/style-guide-and-content-model/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,19 +332,22 @@ Note that regardless of the identifier you use (letters, words), footnotes will

## Headers

Headers must adequately describe the content under them. Headers can either follow the guidelines for writing titles or can be written as questions. Use sentence casing for headers. Each header on a page must be unique.
Headers must adequately describe the content under them. Headers can either follow the [guidelines for writing titles](/contributing/style-guide-and-content-model/contents-of-a-github-docs-article#titles) or can be written as questions. Use sentence casing for headers.

If an article has headers, the headers must start with an H2 level header. You can use H3 and H4 level headers to further organize content into related groups, but you cannot skip header levels. There must be text content between a header and subheader, such as an introduction.
* **Use:**

```markdown
## HEADER (H2)
TEXT
### SUBHEADER (H3)
TEXT
#### SUBHEADER (H4)
TEXT
```

Expand All @@ -356,10 +359,59 @@ If an article has headers, the headers must start with an H2 level header. You c
#### SUBHEADER (H4)
```

When referring to headers, surround the header name with quotation marks.
* **Use:** Under "User licenses," view your total licenses.
Each header at the same level on a page must be unique.

* **Use:**

```markdown
## Examples (H2)
TEXT
### Prompts for writing code (H3)
TEXT
### Prompts for writing tests (H3)
TEXT
```

* **Use:**

```markdown
## Prompts for writing code (H2)
TEXT
### Example (H3)
TEXT
## Prompts for writing tests (H2)
TEXT
### Example (H3)
TEXT
```

* **Avoid:**

```markdown
## Example prompts (H2)
TEXT
For more information, see the "[AUTOTITLE](/contributing/style-guide-and-content-model/contents-of-a-github-docs-article)."
### Example (H3)
TEXT
### Example (H3)
TEXT
```

## Images

Expand Down

0 comments on commit c9beaf1

Please sign in to comment.