Added guidelines about where links are allowed

[lburcher7]

Added guidance about links not being allowed in short descriptions and concept modules. Two files were updated.

Issue: #594

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 70c34e53-4d12-47b0-8dbd-3a3dfa21c756

📥 Commits

Reviewing files that changed from the base of the PR and between 4171f2b and 257451b.

📒 Files selected for processing (1)

• supplementary_style_guide/style_guidelines/links.adoc

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

---

📝 Summary

Summary by CodeRabbit

• Documentation
  • Added guidance on where inline links may be used in concept, procedure, reference, and short-description topics.
  • Clarified that inline links are not compatible with short descriptions, alongside bulleted lists and multiple paragraphs.

Walkthrough

The style guide now defines where inline links are allowed. It also identifies inline links as incompatible with short descriptions.

Changes

Inline link guidance

Layer / File(s)	Summary
Define inline-link rules supplementary_style_guide/style_guidelines/links.adoc, supplementary_style_guide/style_guidelines/structure.adoc	The links guide defines inline-link rules for concept, procedure, and reference topics. It directs essential or supplemental links to “Related Links” when applicable. The structure guide prohibits inline links in short descriptions.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: ingridt1, neal-timpe, sheriff-rh

Merge Risk: ⚪ Minimal · up to 4171f

The updated guidance consistently restricts inline links, with no substantiated issue blocking merge.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the added guidance about where links are allowed.
Description check	✅ Passed	The description explains the change, identifies the two affected topics, and includes the related issue link. The optional Additional information section is not included, but the required information …
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[IngridT1]

LGTM with the small changes.

[sheriff-rh]

Changes LGTM, thank you!

[IngridT1]

Neal Timpe and Andy Taylor approved the PR.