From bd05b74808417d2553326b849e35239e228ee8a5 Mon Sep 17 00:00:00 2001 From: BigDataWriter <55607333+BigDataWriter@users.noreply.github.com> Date: Mon, 7 Feb 2022 19:12:38 -0800 Subject: [PATCH] docs: improve wording of using Markdown file paths (#6633) * Update docs-markdown-features.mdx * Author meant to recommend the use of full paths rather than relative paths: Technical edit * Revised intro to naturally introduce the benefits of this recommendation: Style edit * Update website/docs/guides/docs/docs-markdown-features.mdx * Update website/docs/guides/docs/docs-markdown-features.mdx Co-authored-by: Joshua Chen --- website/docs/guides/docs/docs-markdown-features.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/docs/docs-markdown-features.mdx b/website/docs/guides/docs/docs-markdown-features.mdx index fe2660b212..40be16cb9e 100644 --- a/website/docs/guides/docs/docs-markdown-features.mdx +++ b/website/docs/guides/docs/docs-markdown-features.mdx @@ -29,7 +29,7 @@ Reference to another [document in a subfolder](subfolder/doc3.md). :::tip -It is better to use relative file paths links instead of relative links: +Using relative _file_ paths (with `.md` extensions) instead of relative _URL_ links provides the following benefits: - links will keep working on the GitHub interface - you can customize the document slugs without having to update all the links