diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 738eca3b4..2b19bc5f8 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -3,7 +3,13 @@ Space Wizards Development Wiki [The Robust Book](index.md) -- [Links](en/links.md) +Meta +==== + +---------------------- + +- [Guide to Editing Docs](en/meta/guide-to-editing-docs.md) +- [Docs Example Page](en/meta/docs-example-page.md) General Development =================== @@ -132,11 +138,4 @@ Community - [Grafana Dashboards](en/community/infrastructure-reference/grafana-dashboards.md) - [Space Wizards Hub Rules](en/community/space-wizards-hub-rules.md) - [Space Wizards Role Hierarchy](en/community/space-wizards-role-hierarchy.md) -- [Discord Rich Presence Repository](en/community/discord-rich-presence-repository.md) - -Miscellaneous -============= - ----------------------- - -- [Test Page](en/miscellaneous/test_page.md) \ No newline at end of file +- [Discord Rich Presence Repository](en/community/discord-rich-presence-repository.md) \ No newline at end of file diff --git a/src/en/assets/images/meta-create-fork.png b/src/en/assets/images/meta-create-fork.png new file mode 100644 index 000000000..a95bd65b0 Binary files /dev/null and b/src/en/assets/images/meta-create-fork.png differ diff --git a/src/en/assets/images/meta-edit-file.png b/src/en/assets/images/meta-edit-file.png new file mode 100644 index 000000000..b51f2be52 Binary files /dev/null and b/src/en/assets/images/meta-edit-file.png differ diff --git a/src/en/assets/images/meta-edit-page-button.png b/src/en/assets/images/meta-edit-page-button.png new file mode 100644 index 000000000..13e741cdd Binary files /dev/null and b/src/en/assets/images/meta-edit-page-button.png differ diff --git a/src/en/links.md b/src/en/links.md deleted file mode 100644 index 817dfd456..000000000 --- a/src/en/links.md +++ /dev/null @@ -1,3 +0,0 @@ -# Links - -{{#template templates/porting.md}} \ No newline at end of file diff --git a/src/en/meta/docs-example-page.md b/src/en/meta/docs-example-page.md new file mode 100644 index 000000000..2645b07eb --- /dev/null +++ b/src/en/meta/docs-example-page.md @@ -0,0 +1,88 @@ +# Docs Example Page + +This page is used for showing off plugins and styling available in this `mdbook` instance. + +Its best to view the raw markdown source of this page, which you can do using the button in the top right and clicking 'Code' instead of 'Preview' on GitHub. + +## markdown + +Best to look at [a general markdown guide](https://www.markdownguide.org/getting-started/) for this! There's a lot. + +**bold** + +*italic* + +~~strikethrough~~ + +## templates + +You can also pass args into a template invocation which are interpolated into the page by `mdbook-template`. See [their docs](https://github.com/sgoudham/mdbook-template#format) for more info + +`\{\}#template {link to template file})\}\}` + +{{#template ../templates/outdated.md}} + +{{#template ../templates/wip.md}} + +{{#template ../templates/stub.md}} + +## admonishments + +All available admonishment types. + +To use an admonishment: +`````` +```admonishment {type} "{text you want as title, or leave blank}" +description +``` +`````` + +```admonish note +``` + +```admonish abstract +``` + +```admonish info +``` + +```admonish tip +``` + +```admonish success +``` + +```admonish question +``` + +```admonish warning +``` + +```admonish failure +``` + +```admonish danger +``` + +```admonish bug +``` + +```admonish example +``` + +```admonish quote +``` + +## latex + +\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\] + +## mermaid + +```mermaid +graph TD; + A-->B; + A-->C; + B-->D; + C-->D; +``` \ No newline at end of file diff --git a/src/en/meta/guide-to-editing-docs.md b/src/en/meta/guide-to-editing-docs.md new file mode 100644 index 000000000..d6fec4cc3 --- /dev/null +++ b/src/en/meta/guide-to-editing-docs.md @@ -0,0 +1,27 @@ +# Guide to Editing Docs + +Hello! As you may be able to notice, this docs site is completely open source and free to edit on GitHub. You can see the GitHub page for this site at [https://github.com/space-wizards/docs](https://github.com/space-wizards/docs). + +There are a couple things to keep in mind when contributing. While we disallow web-edit PRs (those made exclusively on GitHub) on the main Space Station 14 & Robust Toolbox repos, that is not the case here. **Web-editing is encouraged** to make editing documentation as painless as possible. + +If you want to get an idea of what features are at your disposal when writing documentation, go to our [Docs Example Page](./docs-example-page.md). + +To start a basic edit of a page, simply follow these steps: + +1. Create an accout on GitHub, or log in if you already have one. + +2. Fork the [space-wizards/docs](https://github.com/space-wizards/docs) repo on GitHub. + +![](../assets/images/meta-create-fork.png) + +3. Click the 'View & Edit Page on GitHub` icon in the very top right of any page on this site. + +![](../assets/images/meta-edit-page-button.png) + +4. Click the 'Edit this file' button at the top right of the file view. + +![](../assets/images/meta-edit-file.png) + +5. Make your changes, then commit & create a pull request! We'll handle the rest. + +More in-depth information for contributors, like how to test locally & port pages from our old docs site, is available on our [README](https://github.com/space-wizards/docs/blob/master/README.md) for the GitHub docs site. \ No newline at end of file diff --git a/src/en/miscellaneous/test_page.md b/src/en/miscellaneous/test_page.md deleted file mode 100644 index be86fcc41..000000000 --- a/src/en/miscellaneous/test_page.md +++ /dev/null @@ -1,33 +0,0 @@ -# Example Page - -This page is used for showing off plugins available in this `mdbook` instance. - -## admonishes & templates - -`\{\}#template ../templates/(file)\}\}` - -{{#template ../templates/outdated.md}} - -{{#template ../templates/wip.md}} - -{{#template ../templates/stub.md}} - -### hi2 subheading - -## latex - -\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\] - -## mermaid - -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` - -### hi4 subheading - -#### hi5 subsubheading \ No newline at end of file diff --git a/src/index.md b/src/index.md index 2ace020c2..2cbc3c4cd 100644 --- a/src/index.md +++ b/src/index.md @@ -9,7 +9,11 @@ Do not rely on any links to this site (spacestation14.io/docs) to remain alive This is the developer's wiki. If you are a player, you are looking for [the player wiki](https://wiki.spacestation14.io/wiki/Main_Page). ``` -This wiki is written in [Markdown](https://docs.requarks.io/en/editors/markdown). If you would like to make contributions to this wiki, it's hosted fully open source on GitHub and you can make a webedit PR to any page using the button in the top right. +This wiki is written in [Markdown](https://docs.requarks.io/en/editors/markdown) using `mdbook`. You can view our README.md for the docs site [here](https://github.com/space-wizards/docs/blob/master/README.md), which has useful information. + +```admonish info "Making contributions" +If you would like to make contributions to this documentation site, it's hosted fully open source on GitHub and you can make a webedit PR to any page using the button in the top right. Check out our [Guide to Editing Docs](en/meta/guide-to-editing-docs.md) page for more information. +``` ## Getting Started diff --git a/theme/index.hbs b/theme/index.hbs index d289ebe8f..e4de8f93f 100644 --- a/theme/index.hbs +++ b/theme/index.hbs @@ -149,7 +149,7 @@ {{/if}} {{#if git_repository_edit_url}} - + {{/if}}