Skip to content

Commit

Permalink
Docs: add link guidance (#770)
Browse files Browse the repository at this point in the history
  • Loading branch information
ffe9f8 committed Feb 13, 2024
1 parent 9feb51c commit 9ff2bd3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions STYLE-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,12 @@ uint256 \_amount
| --- | --- |
| For more information on General Message Passing, check out [Axelar's YouTube channel](https://www.youtube.com/channel/UCf8GFg58fdp1iZwLAOV1Tgg). | For more information on General Message Passing, check out Axelar's YouTube channel [here](https://www.youtube.com/channel/UCf8GFg58fdp1iZwLAOV1Tgg). |

* Use the root-relative path instead of a relative one when linking in docs. This makes links less likely to break if a file is moved into another folder.

| **Recommended** | **Not recommended** |
| --- | --- |
| `Create a [custom token](/dev/glossary#custom-token).` | `Create a [custom token](../../reference/glossary/#custom-token).` |

### Lists

* When writing a list, either use complete sentences for all elements or no elements. Either every element has a period at the end, or none of them do. Do not mix and match.
Expand Down

0 comments on commit 9ff2bd3

Please sign in to comment.