api-ref-001 should API docs Include links to related elements and additional resources in reference articles.
Referring and linking
A reference page rarely stands alone. This page covers pointing readers to related elements and further resources; general guidance on link text and formatting lives on the links page.
Link to related elements
Section titled “Link to related elements”Examples
- ✓ See also:
Session.refresh,SessionOptions, and the authentication guide. - ✗ For related methods, search the reference.
Rationale
Related links help a reader move from one element to the neighboring ones they will likely need next.