From a5f3d839ecff924a764bfeaa579973dec3329465 Mon Sep 17 00:00:00 2001 From: Aramis Date: Tue, 30 Jan 2024 22:43:30 -0500 Subject: [PATCH] fix links issue Signed-off-by: Aramis --- docs/references/writing-a-glossary-entry.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/references/writing-a-glossary-entry.md b/docs/references/writing-a-glossary-entry.md index ecc9f22bd1..90a13e9675 100644 --- a/docs/references/writing-a-glossary-entry.md +++ b/docs/references/writing-a-glossary-entry.md @@ -62,7 +62,13 @@ You may not be able to fully define what you want in a single sentence. Use more If the term you're defining has a better or more in depth source for that information, link to it. This can include plugin specific concept documents, external documentation, or core framework documentation. -You should format these links as `See [link1 title](link1.url) for more details`. Additional links beyond the first one should be appended with `and` or `or` as necessary. +You should format these links as + +```md +See [the glossary](./glossary.md) for more details. +``` + +. Additional links beyond the first one should be appended with `and` or `or` as necessary. ## Putting it all together