Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme to use devdocs site for links to guides #27133

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −7
Open

Update readme to use devdocs site for links to guides #27133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<img width="15%" alt="Discord" hspace="3%" src=".github/assets/discord-dark.png">
</picture>
</a>
<a href="https://codedocs.paradisestation.org">
<a href="https://devdocs.paradisestation.org">
<picture>
<source media="(prefers-color-scheme: dark)" srcset=".github/assets/book-light.png">
<source media="(prefers-color-scheme: light)" srcset=".github/assets/book-dark.png">
Expand Down Expand Up @@ -56,36 +56,35 @@
> [!TIP]
> Want to contribute for the first time but unsure where to start?<br>
> Join our Discord and check out the [#coding_chat](https://discord.com/channels/145533722026967040/145700319819464704) channel for helpful links and advice!<br>
> 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

- ### [Dream Maker (DM) Reference](https://www.byond.com/docs/ref/)

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.<br>
> Building Paradise is quick and simple, all you need to install is [BYOND](https://www.byond.com/download/).<br>
> You can learn more in our [Installation Guide](.github/DOWNLOADING.md).
- ### [Paradise Station Development Team Structure](https://www.paradisestation.org/dev/policy/)

Expand Down