Skip to content

Commit ea0b0a8

Browse files
hardingbitschmidty
authored andcommittedJun 28, 2024·
STYLE: add section about linking
1 parent 841f644 commit ea0b0a8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed
 

‎STYLE.md

+19
Original file line numberDiff line numberDiff line change
@@ -194,3 +194,22 @@ spelled the same.
194194
for placing a space between a number and its unit of measurement, e.g.
195195
"1 sat/vB" or "20 MB" are acceptable. Exception: percentages, e.g.
196196
"50%" is acceptable.
197+
198+
## Linking
199+
200+
- **Separate links:** avoid placing two links immediately next to each
201+
other as they may appear as one link. Discouraged:
202+
[package](/en/topics/package-relay/) [replace-by-fee](/en/topics/replace-by-fee/).
203+
Preferred:
204+
[replace-by-fee](/en/topics/replace-by-fee/) for
205+
[packages](/en/topics/package-relay/).
206+
207+
- **Link abbreviations not expansions:** when introducing an
208+
abbreviation and including a link at the same time, link the
209+
abbrevation rather than the expansion. The goal is to minimize the
210+
amount of special formatting on the page (e.g. blue links) without
211+
reducing the information density. Discouraged: [topologically
212+
restricted until
213+
confirmation](/en/topics/version-3-transaction-relay/)
214+
(TRUC). Preferred: topologically restricted until confirmation
215+
([TRUC](/en/topics/version-3-transaction-relay/)).

0 commit comments

Comments
 (0)
Please sign in to comment.