From eb3603ca0e23a7db9bb9c2cb94ac7c5225c835f1 Mon Sep 17 00:00:00 2001 From: SabreML <57483089+SabreML@users.noreply.github.com> Date: Tue, 27 Feb 2024 20:57:05 +0000 Subject: [PATCH 1/3] Autodoc link --- .github/guides/AUTODOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/guides/AUTODOC.md b/.github/guides/AUTODOC.md index dd2f30627b7d..9b3b07f68470 100644 --- a/.github/guides/AUTODOC.md +++ b/.github/guides/AUTODOC.md @@ -1,5 +1,5 @@ # dmdoc -[DOCUMENTATION]: **PUT DOCUMENTATION LINK HERE** +[DOCUMENTATION]: https://docs.cm-ss13.com/ [BYOND]: https://secure.byond.com/ From 80a71fbe63d96c8ed9e95fab77b0dffaa776db08 Mon Sep 17 00:00:00 2001 From: SabreML <57483089+SabreML@users.noreply.github.com> Date: Tue, 27 Feb 2024 20:57:28 +0000 Subject: [PATCH 2/3] Corrected dmdoc link --- .github/guides/AUTODOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/guides/AUTODOC.md b/.github/guides/AUTODOC.md index 9b3b07f68470..3dba20726b7a 100644 --- a/.github/guides/AUTODOC.md +++ b/.github/guides/AUTODOC.md @@ -3,7 +3,7 @@ [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 From 9d4d9f4b43f48e78d3b788bcf8f7b1578ef6452c Mon Sep 17 00:00:00 2001 From: SabreML <57483089+SabreML@users.noreply.github.com> Date: Tue, 27 Feb 2024 20:58:33 +0000 Subject: [PATCH 3/3] Codebase name --- .github/guides/AUTODOC.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/guides/AUTODOC.md b/.github/guides/AUTODOC.md index 3dba20726b7a..90e5b2d1ac66 100644 --- a/.github/guides/AUTODOC.md +++ b/.github/guides/AUTODOC.md @@ -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.