Skip to content

Commit

Permalink
Style guide note about root-relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
timothymcmackin committed Aug 28, 2024
1 parent ec1751d commit cde3b24
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/reference/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Documentation style guide
authors: Tim McMackin
last_update:
date: 15 January 2024
date: 23 August 2024
---

## Overall Tezos-related issues
Expand Down Expand Up @@ -110,3 +110,7 @@ For example, instead of "We will see how you can deploy smart contracts to Tezos
- Structure lists and headings in a consistent way.
For example, make sure each list item is capitalized and punctuated in the same way.
List items should be all complete sentences or all sentence fragments, not a mix.

## Links

- Use root-relative links, as in `[Target page](/folder/folder/target)`, because the target path of relative links as in `[Target page](./target)` can change based on whether the user's browser has a trailing slash in the URL.

0 comments on commit cde3b24

Please sign in to comment.