Skip to content

Commit

Permalink
AUTODOC.md updates (#5840)
Browse files Browse the repository at this point in the history
# About the pull request

Adds a link to the auto-generated codedocs page to
`.github/guides/AUTODOC.md`.

Also updates the link to the dmdoc repo, and changes '/tg/station' to
'CM-SS13'.

# Explain why it's good for the game

There's been a big bolded placeholder message right at the top of the
file for 2 years and nobody noticed lol

# Testing Photographs and Procedure
<details>
<summary>Screenshots & Videos</summary>

### Before:

![image](https://github.com/cmss13-devs/cmss13/assets/57483089/27af761b-9ab6-4980-a8f2-b7a8f7b0194f)
<hr>

### After:

![image](https://github.com/cmss13-devs/cmss13/assets/57483089/c19496a9-b14f-42d7-bc95-277adb4c7b17)

</details>


# Changelog
N/A
  • Loading branch information
SabreML authored Feb 28, 2024
1 parent 05667f4 commit 527acda
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .github/guides/AUTODOC.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# dmdoc
[DOCUMENTATION]: **PUT DOCUMENTATION LINK HERE**
[DOCUMENTATION]: https://docs.cm-ss13.com/

[BYOND]: https://secure.byond.com/

[DMDOC]: https://github.com/SpaceManiac/SpacemanDMM/tree/master/src/dmdoc
[DMDOC]: https://github.com/SpaceManiac/SpacemanDMM/tree/master/crates/dmdoc

[DMDOC] is a documentation generator for DreamMaker, the scripting language
of the [BYOND] game engine. It produces simple static HTML files based on
Expand All @@ -13,9 +13,9 @@ We use **dmdoc** to generate [DOCUMENTATION] for our code, and that documentatio
is automatically generated and built on every new commit to the master branch

This gives new developers a clickable reference [DOCUMENTATION] they can browse to better help
gain understanding of the /tg/station codebase structure and api reference.
gain understanding of the CM-SS13 codebase structure and api reference.

## Documenting code on /tg/station
## Documenting code on CM-SS13
We use block comments to document procs and classes, and we use `///` line comments
when documenting individual variables.

Expand Down

0 comments on commit 527acda

Please sign in to comment.