From 9ff2bd3173b86df60f1af9ee79e0a59e7bbea03f Mon Sep 17 00:00:00 2001 From: MC <149421156+ffe9f8@users.noreply.github.com> Date: Tue, 13 Feb 2024 10:51:51 -0500 Subject: [PATCH] Docs: add link guidance (#770) --- STYLE-GUIDE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index 6c5bd8d32..492b45ead 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -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.