summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-07-06 01:04:05 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-09-14 18:43:59 -0400
commit1dde811c36c2d03c17df4d09d978907bbd608787 (patch)
treeccafc0de2056834125c33c557926d93130cb28ab /docs
parenta352b1101c4f884c2248da853d47277d534dfbe4 (diff)
downloadSMAPI-1dde811c36c2d03c17df4d09d978907bbd608787.tar.gz
SMAPI-1dde811c36c2d03c17df4d09d978907bbd608787.tar.bz2
SMAPI-1dde811c36c2d03c17df4d09d978907bbd608787.zip
group technical docs, add general shortcut for mod build package docs (#651)
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md8
-rw-r--r--docs/release-notes.md4
-rw-r--r--docs/technical/mod-package.md (renamed from docs/mod-build-config.md)2
-rw-r--r--docs/technical/screenshots/code-analyzer-example.png (renamed from docs/screenshots/code-analyzer-example.png)bin3473 -> 3473 bytes
-rw-r--r--docs/technical/smapi.md (renamed from docs/technical-docs.md)8
-rw-r--r--docs/technical/web.md (renamed from docs/web-services.md)2
6 files changed, 15 insertions, 9 deletions
diff --git a/docs/README.md b/docs/README.md
index e4220de2..4b9c97a1 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -38,16 +38,16 @@ doesn't change any of your game files. It serves eight main purposes:
something goes wrong. (Via the bundled SaveBackup mod.)_
## Documentation
-Have questions? Come [chat on Discord](https://discord.gg/KCJHWhX) with SMAPI developers and other
-modders!
+Have questions? Come [chat on Discord](https://stardewvalleywiki.com/Modding:Community) with SMAPI
+developers and other modders!
### For players
* [Player guide](https://stardewvalleywiki.com/Modding:Player_Guide)
### For modders
* [Modding documentation](https://stardewvalleywiki.com/Modding:Index)
-* [Mod build configuration](mod-build-config.md)
+* [Mod build configuration](technical/mod-package.md)
* [Release notes](release-notes.md)
### For SMAPI developers
-* [Technical docs](technical-docs.md)
+* [Technical docs](technical/smapi.md)
diff --git a/docs/release-notes.md b/docs/release-notes.md
index efac8f41..3f955e78 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -1,3 +1,5 @@
+&larr; [README](README.md)
+
# Release notes
## 3.0 (upcoming release)
These changes have not been released yet.
@@ -674,7 +676,7 @@ Released 14 October 2017 for Stardew Valley 1.2.30–1.2.33.
* **Command-line install**
For power users and mod managers, the SMAPI installer can now be scripted using command-line arguments
- (see [technical docs](technical-docs.md#command-line-arguments)).
+ (see [technical docs](technical/smapi.md#command-line-arguments)).
### Change log
For players:
diff --git a/docs/mod-build-config.md b/docs/technical/mod-package.md
index 6c8ea2fa..43682bfb 100644
--- a/docs/mod-build-config.md
+++ b/docs/technical/mod-package.md
@@ -1,3 +1,5 @@
+&larr; [SMAPI](../README.md)
+
The **mod build package** is an open-source NuGet package which automates the MSBuild configuration
for SMAPI mods and related tools. The package is fully compatible with Linux, Mac, and Windows.
diff --git a/docs/screenshots/code-analyzer-example.png b/docs/technical/screenshots/code-analyzer-example.png
index de38f643..de38f643 100644
--- a/docs/screenshots/code-analyzer-example.png
+++ b/docs/technical/screenshots/code-analyzer-example.png
Binary files differ
diff --git a/docs/technical-docs.md b/docs/technical/smapi.md
index 5ef6dfb1..a006ff1a 100644
--- a/docs/technical-docs.md
+++ b/docs/technical/smapi.md
@@ -1,10 +1,10 @@
-&larr; [README](README.md)
+&larr; [README](../README.md)
This file provides more technical documentation about SMAPI. If you only want to use or create
mods, this section isn't relevant to you; see the main README to use or create mods.
-This document is about SMAPI itself; see also [mod build package](mod-build-config.md) and
-[web services](web-services.md).
+This document is about SMAPI itself; see also [mod build package](mod-package.md) and
+[web services](web.md).
# Contents
* [Customisation](#customisation)
@@ -102,4 +102,4 @@ on the wiki for the first-time setup.
4. Zip the two folders.
## Release notes
-See [release notes](release-notes.md).
+See [release notes](../release-notes.md).
diff --git a/docs/web-services.md b/docs/technical/web.md
index 601152de..c8888623 100644
--- a/docs/web-services.md
+++ b/docs/technical/web.md
@@ -1,3 +1,5 @@
+&larr; [README](../README.md)
+
**SMAPI.Web** contains the code for the `smapi.io` website, including the mod compatibility list
and update check API.