Merge pull request #36 from SidingsMedia/main

V0.1.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,23 +1,21 @@
 <!-- 
-SPDX-FileCopyrightText: Copyright (c) 2021 Sidings Media
+SPDX-FileCopyrightText: Copyright (c) 2021 Sidings Media 
 
-SPDX-License-Identifier: CC0-1.0 
+SPDX-License-Identifier: CC0-1.0
 -->
+
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
+title: "[BUG]"
+labels: bug
 assignees: ''
 
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
-**Type**
-Hardware? Software?
-**Product**
-Desktop Client? Android Client? Relay Board?
+
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Go to '...'
@@ -32,15 +30,15 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. Windows]
- - OS Version:
- - Release: [e.g. 1.0.0]
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
  - Device: [e.g. iPhone6]
  - OS: [e.g. iOS8.1]
- - Browser: [e.g. stock browser, safari]
- - Release: [e.g. 22]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,13 +1,14 @@
 <!-- 
-SPDX-FileCopyrightText: Copyright (c) 2021 Sidings Media
+SPDX-FileCopyrightText: Copyright (c) 2021 Sidings Media 
 
-SPDX-License-Identifier: CC0-1.0 
+SPDX-License-Identifier: CC0-1.0
 -->
+
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
+title: "[FEATURE]"
+labels: enhancement
 assignees: ''
 
 ---

.github/workflows/spellcheck.yml

@@ -0,0 +1,11 @@
+name: Spellcheck
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: igsekor/[email protected]
+        name: Spellcheck

.gitignore

@@ -9,4 +9,5 @@ Debug
 *.componentinfo.xml
 *.cproj
 *.atsln
-.vs
+.vs
+docs/build

.reuse/dep5

@@ -9,4 +9,8 @@ License: CC-BY-SA-4.0
 
 Files: .github/workflows/*
 Copyright: Copyright (c) 2021 Sidings Media
+License: CC0-1.0
+
+Files: dictionaries/*
+Copyright: Copyright (c) 2021 Sidings Media
 License: CC0-1.0

.spellcheck.yml

@@ -0,0 +1,20 @@
+matrix:
+- name: reST
+  sources:
+  - 'docs/**/*.rst'
+  default_encoding: utf-8
+  hunspell:
+    d: en_GB
+    encoding: utf-8
+  dictionary:
+    wordlists:
+    - dictionaries/companies.txt
+    - dictionaries/englishCorrect.txt
+    - dictionaries/fileextensions.txt
+    - dictionaries/misc.txt
+    - dictionaries/protocol.txt
+    - dictionaries/rst.txt
+    - dictionaries/technical.txt
+    output: build/dictionary/dictionary.dic
+
+

.spellcheck.yml.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: Copyright (c) 2021 Sidings Media
+
+SPDX-License-Identifier: CC0-1.0

dictionaries/companies.txt

@@ -0,0 +1,5 @@
+smrc
+sidingsmedia
+SidingsMedia
+github
+gitter

dictionaries/englishCorrect.txt

@@ -0,0 +1,2 @@
+licence
+licences

dictionaries/fileextensions.txt

@@ -0,0 +1,11 @@
+png
+svg
+jpg
+jpeg
+gif
+gifs
+GIFs
+favicon
+favicons
+html
+md

dictionaries/misc.txt

@@ -0,0 +1,8 @@
+behaviour
+quickstart
+recurse
+opensource
+initialised
+styleguide
+cppguide
+htmlcssguide

dictionaries/protocol.txt

@@ -0,0 +1,8 @@
+mailto
+http
+https
+www
+url
+urls
+localhost
+dcc

dictionaries/rst.txt

@@ -0,0 +1,5 @@
+toctree
+ndx
+maxdepth
+utm
+im

dictionaries/technical.txt

@@ -0,0 +1,66 @@
+wi
+fi
+api
+frontend
+preload
+bootloaders
+submodules
+submodule
+git's
+ipc
+nodejs
+NodeJS
+closeDevTools
+ctrl
+ctrlChannel
+electronjs
+macOS
+openDevTools
+preloader
+preloaders
+processplatform
+registerIPC
+setFullScreen
+src
+titlebar
+toggleDevTools
+toggleFullScreen
+unmaximize
+unMaximize
+config
+json
+linux
+BrowserWindow
+unmaximizes
+browserwindowoptions
+getFocus
+isMaximized
+windowSettings
+dev
+XMLHttpRequest
+init
+pre
+scm
+wip
+ui
+mainboard
+otherboard
+repo
+repos
+bootloader
+githubusercontent
+bw
+dep
+changelog
+autolinked
+kicad
+io
+pageLayout
+tsguide
+wks
+TypeScript
+dco
+alwaysSignOff
+developercertificate
+linuxfoundation
+signoff

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/stable-warning.js

@@ -0,0 +1,40 @@
+// SPDX-FileCopyrightText: Copyright (c) 2021 Sidings Media
+
+// SPDX-License-Identifier: MIT
+
+function warnUnstable() {
+    var warning = document.createElement('div');
+	fetch('https://raw.githubusercontent.com/SidingsMedia/Sidings-Media-Railway-Controller/stable/versions.json').then(response => response.json()).then(data => {
+		var version = window.location.pathname.split('/')[4]
+		switch (data[version]) {
+			case 'stable':
+				return
+			case 'pre-release':
+				warning.innerHTML = "<p class='first admonition-title'>Note</p> " +
+					"<p class='last'> " +
+					"This document is a pre-release version and as such this documentation may be unstable and may change. " +
+					"Documentation is available for the <a href='/projects/smrc/en/stable/'>current stable release</a> and previous versions can be selected by using the &ldquo;v:&rdquo; menu in the navigation pane on the left." +
+					"</p>";
+				break
+			case 'unsupported':
+				warning.innerHTML = "<p class='first admonition-title'>Note</p> " +
+					"<p class='last'> " +
+					"This documentation is now unsupported and is outdated. You should use the current stable release instead." +
+					"Documentation is available for the <a href='/projects/smrc/en/stable/'>current stable release</a> and previous versions can be selected by using the &ldquo;v:&rdquo; menu in the navigation pane on the left." +
+					"</p>";
+				break
+            default:
+                warning.innerHTML = "<p class='first admonition-title'>Note</p> " +
+                    "<p class='last'> " +
+                    "This documentation is a development version and as such it is unstable and is prone to change at any time. " +
+                    "Documentation is available for the <a href='/projects/smrc/en/stable/'>current stable release</a> and previous versions can be selected by using the &ldquo;v:&rdquo; menu in the navigation pane on the left." +
+                    "</p>";
+                break
+		}
+        warning.setAttribute('class', 'admonition danger');
+	})
+	var parent = document.querySelector('div.document')
+	parent.insertBefore(warning, parent.firstChild);
+}
+
+document.addEventListener('DOMContentLoaded', warnUnstable);

docs/boards/bootloader.rst

@@ -4,20 +4,22 @@ Bootloader
 Repository
 ----------
 
-The repository for the bootloaders can be located at https://github.com/SidingsMedia/SMRC-bootloader  
+The source files for the bootloaders can be located in the
+`SMRC-bootloader`_ repository.  
 
 Use of bootloaders
 ------------------
 
-The bootloader is used on all official SMRC boards (i.e all boards in the `SMRC-hardware repo`_). It can also be used in your own SMRC boards.
+The bootloader is used on all official SMRC boards (i.e all boards in
+the `SMRC-hardware`_) repository. It can also be used in your own SMRC
+boards.
 
-.. _`SMRC-hardware repo`: https://github.com/SidingsMedia/SMRC-hardware
 
 General Requirements
 --------------------
 
 - Must support updating firmware over USB
-- Must make availible to the firmware the current bootloader version
+- Must make available to the firmware the current bootloader version
 
 Main board
 ----------
@@ -27,7 +29,7 @@ Main board
 Requirements
 ^^^^^^^^^^^^
 
-- Must verify that the firmware being uploaded is correct for the proccessor
+- Must verify that the firmware being uploaded is correct for the processor
 
 Other Boards
 ------------
@@ -38,3 +40,6 @@ Requirements
 ^^^^^^^^^^^^
 
 - Must verify that the firmware being uploaded is correct for the specific board
+
+.. _`SMRC-hardware`: https://github.com/SidingsMedia/SMRC-hardware
+.. _`SMRC-bootloader`: https://github.com/SidingsMedia/SMRC-bootloader

docs/boards/firmware.rst

@@ -4,4 +4,7 @@ Firmware
 Repository
 ----------
 
-The repository for the firmware can be located at https://github.com/SidingsMedia/SMRC-firmware  
+The source files for the firmware can be located in the `SMRC-firmware`_
+repository.  
+
+.. _`SMRC-firmware`: https://github.com/SidingsMedia/SMRC-firmware

docs/boards/hardware.rst

@@ -4,4 +4,7 @@ Hardware
 Repository
 ----------
 
-The repository for the hardware can be located at https://github.com/SidingsMedia/SMRC-hardware  
+The source files for the hardware can be located in the `SMRC-hardware`_
+repository.
+
+.. _`SMRC-hardware`: https://github.com/SidingsMedia/SMRC-hardware