From dcfc7def7061650fae13b975e2e3abe23c45653a Mon Sep 17 00:00:00 2001 From: Sean <12197162+S34NW@users.noreply.github.com> Date: Sat, 19 Oct 2024 09:47:00 +0100 Subject: [PATCH] Update readme to use devdocs site for links to guides The new devdocs site is great, we should be directing users to it. Signed-off-by: Sean <12197162+S34NW@users.noreply.github.com> --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 666b84e5f44..0815cdb96db 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Discord - + @@ -56,7 +56,7 @@ > [!TIP] > Want to contribute for the first time but unsure where to start?
> Join our Discord and check out the [#coding_chat](https://discord.com/channels/145533722026967040/145700319819464704) channel for helpful links and advice!
-> Alternatively, have a look at our community maintained [Getting Started Guide](./docs/contributing/getting_started.md) +> Alternatively, have a look at our community maintained [Getting Started Guide](https://devdocs.paradisestation.org/contributing/getting_started/) # Useful Documents and Links @@ -64,28 +64,27 @@ This reference site by the creators of BYOND details information on the DM language, the syntax used, functionality of native procs, and a lot more. This is always useful to have on hand when contributing. -- ### [Autodocumentation Guide](./docs/references/autodoc.md) +- ### [Autodocumentation Guide](https://devdocs.paradisestation.org/references/autodoc/) This guide shows you how to leave code comments that comply with "autodocumentation", a system designed to make everyone's lives easier when reading or reviewing code! -- ### [Code of Conduct](./docs/CODE_OF_CONDUCT.md) +- ### [Code of Conduct](https://devdocs.paradisestation.org/code_of_conduct/) All contributors are expected to read our Code of Conduct before they take part in our community. -- ### [Contribution Guide](./docs/CONTRIBUTING.md) +- ### [Contribution Guide](https://devdocs.paradisestation.org/contributing/) Not sure how to take part and contribute? This guide gives an overview of how to make comments, pull requests, and open issues. This guide also sets out our code standards that we expect all submitted code to adhere to. -- ### [Community Maintained Guide to Contributing](https://paradisestation.org/wiki/index.php?title=Guide_to_Contributing) +- ### [Community Maintained Guide to Contributing](https://devdocs.paradisestation.org/contributing/getting_started/) This community maintained guide covers how to set yourself up for success when attempting to contribute to Paracode. > [!IMPORTANT] > Paradise does not provide precompiled binaries, requiring you to build from source to host a local server.
> Building Paradise is quick and simple, all you need to install is [BYOND](https://www.byond.com/download/).
-> You can learn more in our [Installation Guide](.github/DOWNLOADING.md). - ### [Paradise Station Development Team Structure](https://www.paradisestation.org/dev/policy/)