From b11695ab678abbed46cf691c07e7d872d8ce4be7 Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Fri, 18 Oct 2024 17:34:05 -0700 Subject: [PATCH] Updated link/dir structure for UG --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 339024d289b..1d6e45259bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -257,11 +257,11 @@ DoxyGen is automatically run across the MSDK code as part of the User Guide's bu ### User Guide -An MSDK User Guide is maintained in the [USERGUIDE.md](USERGUIDE.md) file. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage. +The [MSDK User Guide](Documentation/user-guide/index.md) is maintained in the `Documentation/user-guide` folder. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage. When writing markdown links, relative paths should always be used. Additionally, links to local files on the user's filesystem **cannot** be used, since the online copy of the docs will throw a 404 on them. See [Writing Your Docs](https://www.mkdocs.org/user-guide/writing-your-docs/) for more details. -Static resources such as images should be placed in the `res` folder. +Static resources such as images should be placed in the `user-guide/res` folder. ### Building the Documentation