Skip to content

Added guidelines about where links are allowed #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IngridT1 merged 5 commits into from
Sep 16, 2026
Merged

Added guidelines about where links are allowed #596

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4171f2b
Added guidelines about where links are allowed
lburcher7 Sep 14, 2026
2c5d838
Apply suggestion from @IngridT1
IngridT1 Sep 15, 2026
22e3180
Apply suggestion from @IngridT1
IngridT1 Sep 15, 2026
708097c
Apply suggestion from @IngridT1
IngridT1 Sep 15, 2026
257451b
Apply suggestion from @IngridT1
IngridT1 Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions supplementary_style_guide/style_guidelines/links.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
[[links]]
= Links

[[where-links-are-allowed]]
== Where links are allowed

To preserve reader focus and improve content usability, inline links are restricted in some places:

* *Concept topics:* Avoid inline links. Place essential links in the "Related Links" section at the end of the topic.
Comment thread
IngridT1 marked this conversation as resolved.
Outdated
* *Procedure topics:* Inline links are allowed to support task completion.
Comment thread
IngridT1 marked this conversation as resolved.
Outdated
* *Reference topics:* Inline links are allowed but consider moving supplemental links to the "Related Links" section when possible.
Comment thread
IngridT1 marked this conversation as resolved.
Outdated
* *Short descriptions:* Do not include links.
Comment thread
IngridT1 marked this conversation as resolved.
Outdated

[[cross-references]]
== Cross-references

Expand Down
2 changes: 1 addition & 1 deletion supplementary_style_guide/style_guidelines/structure.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Short descriptions help readers find the information that they need and confirm

* Include user intent. Explain *what* the user must do and *why* they must complete that action. Build upon the title--do not repeat it.
* Write for AI and search. High-quality short descriptions are a primary source of metadata for large language models (LLMs) and search engine link previews. A high quality, human-verified summary reduces the risk of AI misinterpretation and saves processing time.
* Do not use DITA-incompatible structures, such as bulleted lists or multiple paragraphs.
* Do not use DITA-incompatible structures, such as bulleted lists, multiple paragraphs, or inline links.

=== Style guidelines ===

Expand Down
Loading