Skip to content

Commit 6578100

Browse files
authored
Move Footnotes guidance to dedicated section (github#34690)
1 parent e5370a5 commit 6578100

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

contributing/content-style-guide.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,16 @@ Workflow runs are delayed when too many workflows run at once. Since many users
125125
- Do not use examples that run more frequently than necessary. For example, instead of running every 5 minutes, consider if the example makes sense to run every 30 minutes instead.
126126
- Use a different time for each example.
127127

128+
## Footnotes
129+
130+
Avoid using footnotes where possible. Consider instead whether you could use a [callout](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#callouts) or present the information in another way. See some [examples of alternatives to footnotes from NICE.org.uk](https://www.nice.org.uk/corporate/ecd6/chapter/footnotes).
131+
132+
If you must use footnotes:
133+
134+
* Use numbers. Do not use typographical symbols or special characters.
135+
* Place footnote markers in square brackets: `[1]`.
136+
* Do not use superscript.
137+
128138
## Headers
129139

130140
Headers must adequately describe the content under it. Follow the same guidelines we use for writing titles. Each header on a page must be unique.
@@ -587,9 +597,7 @@ For tables that use symbols:
587597
Where table data is not truly binary (every value is either "Yes" or "No", for example), text values may be needed in addition to, or instead of, symbols. For example on the page "[About GitHub Support](https://docs.github.com/en/support/learning-about-github-support/about-github-support)", some features are marked as "Available to purchase".
588598
589599
### Use footnotes sparingly
590-
Avoid using footnotes where possible. Consider instead whether you could place a [callout](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#callouts) before or after the table, or present the information in another way. See some [examples of alternatives to footnotes from NICE.org.uk](https://www.nice.org.uk/corporate/ecd6/chapter/footnotes).
591-
592-
If you must use footnotes, use numbers in square brackets [1]. Do not use typographical symbols or special characters.
600+
See "[Footnotes](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#footnotes)."
593601
594602
## Titles
595603

0 commit comments

Comments
 (0)