Fix footnote examples in Markdown docs
What does this MR do?
Resolve discussion in !26663 (comment 307250209)
This MR tidies up the footnote section of the Markdown doc and fixes a typo.
I included the warning about w and _ in the regular text, and made the examples simpler.
The previous iteration included footnote examples that would not render properly (in GitLab), but they did, in fact, render okay (on the docs site). It also made the error more prominent, unnecessarily.
Preview:
Related issues
Related MR: !26663 (merged) Related OKR issue: #205689 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖