Use cspell for spelling

RealOrangeOne · RealOrangeOne · commit 188e7daf7f95 · 2023-06-24T16:45:45.000+01:00
diff --git a/.spelling b/.spelling
@@ -1,79 +1,19 @@
-×
-100x100mm
-11.1V
-15cm
-2.2A.
-2m
-4.5m
-2.5m
-20000Hz
-20Hz
-2200mAh
-250x250mm
-2m
-2mm
-3.3V
-3.81mm
-3m
-4mm
-5cm
-5mm
-7-zip
-7.5mm
-70x84x20mm
-83x99x24mm
-Adafruit
-AprilTag
-Arduino
-booleans
-CamCon
-CamCons
-Codecademy
+# Custom spellings for this repo.
+#
+# Keep each section alphabetically sorted.
+BIDMAS
 Datacamp
-dropdown
-elif
-energised
-enum
-forklift
-FreeCodeCamp
-H0-1
-iMAX
-inputted
-IntelliSense
-kickstart
-L0-3
-LearnPython
-LiPo
-macOS
-Math
-matplotlib
-microswitch
-microswitches
-numpy
-piezo
-plt
+GPIO
 Programiz
-PyCharm
-pyplot
-python3
-r.zone
-R2021b
-scikit-learn
-scipy
-Smallpeice
-SourceBots
-square-ish
-StackOverflow
-submodule
-TargetInfo
-TeckNet
 Tutorialspoint
-Uno
-vcc
-VSCode
-W3Schools
-Webots
-www.python.org
-python-396
-_f_
-×
+
+# Specific
+PULLUP
+sbot
+Smallpeice
+
+# Technical things
+fontawesome
+matplotlib
+scikit
+scipy
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ This will build the site once, and place it in `site/` in the root of the projec
 
 ### Spell checking
 
-This project uses `markdown-spellcheck` for spell checking. Plugins are
+This project uses `cspell` for spell checking. Plugins are
 available for a variety of editors and a command line runner is available
 through `npm`:
 
@@ -59,4 +59,4 @@ npm install
 npm run spellcheck
 ```
 
-Words that `markdown-spellcheck` is unaware of can be added to the `.spelling` file.
+Words that `cspell` is unaware of can be added to the `.spelling` file.
diff --git a/cspell.json b/cspell.json
@@ -0,0 +1,12 @@
+{
+    "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+    "version": "0.2",
+    "dictionaryDefinitions": [
+        {
+            "name": "project-words",
+            "path": "./.spelling",
+            "addWords": true
+        }
+    ],
+    "dictionaries": ["en-gb", "python", "project-words"]
+}
diff --git a/docs/api/arduino.md b/docs/api/arduino.md
@@ -27,7 +27,7 @@ The first few digital pins are occupied by digital inputs, the next few by
 digital outputs, and the analogue pins are attached to ultrasound sensors.
 
 To find out how many inputs and outputs each type of robot has, check the
-[robot docs](/robots/).
+[robot docs]().
 
 You won't be able to change pin mode like in
 a physical robot (see below), but pins 0 and 1 are still unavailable.
diff --git a/docs/api/compass.md b/docs/api/compass.md
@@ -2,7 +2,7 @@
 title: Compass
 ---
 
-The forklift robot has a compass unit. This allows [robots](/robots/) to determine the direction it's facing in the arena.
+The forklift robot has a compass unit. This allows [robots]() to determine the direction it's facing in the arena.
 
 ```python
 # Get the heading of the robot.
diff --git a/docs/api/encoder.md b/docs/api/encoder.md
@@ -10,7 +10,7 @@ Linear encoders are attached to joints that move in a straight line (i.e. raisin
 
 Linear encoders measure the distance the joint has moved from its start position, in *metres*.
 
-All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot](/robots/).
+All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot]().
 
 ```python
 # Get the distance from the start position
@@ -23,7 +23,7 @@ Rotary encoders are attached to joints that rotate (i.e. wheel rotations).
 
 Rotary encoders measure the total rotation the joint has moved from its start position, in *radians*.
 
-All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot](/robots/).
+All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot]().
 
 ```python
 # Get the total rotation from the start position
diff --git a/docs/api/magnet.md b/docs/api/magnet.md
diff --git a/docs/api/radio.md b/docs/api/radio.md
diff --git a/docs/api/servos.md b/docs/api/servos.md
@@ -2,11 +2,7 @@
 title: Servos
 ---
 
-{{% notice note %}}
-Servos only apply to the [physical robot](/robots/physical/).
-{{% /notice %}}
-
-You can control attached servo motors from the [Arduino](/api/arduino/). By default, servos will be unpowered when your robot starts, and can freely rotate when turned by hand. Upon setting a value, they will hold the corresponding position. They will become unpowered again when you turn off your robot, unplug your USB stick, or set their position to the special value `None`.
+You can control attached servo motors from the [Arduino](./arduino.md). By default, servos will be unpowered when your robot starts, and can freely rotate when turned by hand. Upon setting a value, they will hold the corresponding position. They will become unpowered again when you turn off your robot, unplug your USB stick, or set their position to the special value `None`.
 
 ## Querying servos
 
diff --git a/docs/api/touch.md b/docs/api/touch.md
@@ -10,7 +10,7 @@ Microswitches, or touch sensors, are used to measure when something is touching
 
 The touch sensors will be connected to a specific pin in the Arduino, typically wired in such a way that the pin's voltage is changed when the switch is pressed by an object.
 
-To read this, you need to read the digital value of the correct pin. You can get the correct pin number by looking at [the documentation for the robot](/robots/), then writing the code like so:
+To read this, you need to read the digital value of the correct pin. You can get the correct pin number by looking at [the documentation for the robot](), then writing the code like so:
 
 ``` python
 # Get if something is touching the touch sensor.
diff --git a/docs/api/ultrasound.md b/docs/api/ultrasound.md
@@ -8,13 +8,13 @@ Ultrasound sensors can measure distance of objects from the sensor. Ultrasound s
 
 Ultrasound sensors measure distance in a 18 degree diameter cone in front of the sensor, and report the closest measured distance in that cone. Ultrasound sensors also have a maximum distance. (Ultrasound sensors typically also have a minimum distance too, but we do not simulate that in our simulator).
 
-In our robots, ultrasound sensors are connected to the ['Arduino'](/api/arduino) board, which is used to read sensors for many different purposes. Keep reading to learn how to take measurements.
+In our robots, ultrasound sensors are connected to the ['Arduino'](./arduino.md) board, which is used to read sensors for many different purposes. Keep reading to learn how to take measurements.
 
 ## Reading the ultrasound sensor
 
 ### Simulator
 
-The ultrasound sensors will be connected to a specific pin in the Arduino, and will constantly measure distances. Consult the description of the [robot](/robots/) to see which pin you should use. The analogue value of the pin will be the measured distance, in metres.
+The ultrasound sensors will be connected to a specific pin in the Arduino, and will constantly measure distances. Consult the description of the [robot]() to see which pin you should use. The analogue value of the pin will be the measured distance, in metres.
 
 Ultrasound sensors have a maximum range of 2 metres, if objects are further than 2m away from the robot, it will report a distance of 2m.
 
diff --git a/docs/kit/motor-board.md b/docs/kit/motor-board.md
@@ -35,7 +35,7 @@ The case measures 70x84x20mm. Don’t forget that the cables will stick out.
 ## Designs
 You can access the schematics and source code of the firmware on the motor board in the following places. You do not need this information to use the board but it may be of interest to some people.
 
-- [Full Schematics](/docs/motor-schematic.pdf)
+- [Full Schematics](../assets/docs/motor-schematic.pdf)
 - [Firmware Source](https://github.com/sourcebots/motor-v4-fw)
 - [Hardware Source](https://github.com/sourcebots/motor-v4-hw)
 
diff --git a/docs/kit/power-board.md b/docs/kit/power-board.md
@@ -70,6 +70,6 @@ The case measures 83x99x24mm. Don’t forget that the cables will stick out.
 ## Designs
 You can access the schematics and source code of the firmware for the power board in the following places. You do not need this information to use the board but it may be of interest to some people.
 
-- [Full Schematics](/docs/power-schematic.pdf)
+- [Full Schematics](../assets/docs/power-schematic.pdf)
 - [Firmware Source](https://github.com/sourcebots/power-v4-fw)
 - [Hardware Source](https://github.com/sourcebots/power-v4-hw)
diff --git a/docs/kit/servo-assembly/servos.md b/docs/kit/servo-assembly/servos.md
@@ -8,4 +8,4 @@ By itself, an Arduino is incapable of driving servos, without a lot of hard work
 There are a total of sixteen servo connectors, grouped into four groups of four. Servo cables are connected with 0V (the black or brown wire) towards the side of the reset button.
 
 ## Power
-The Arduino itself is powered entirely over USB. If you wish to use servos, you'll need to supply an additional 5V through the connector on the shield from the [power board](/kit/power-board). There are two red LEDs next to the power input that will turn on if the board is correctly powered.
+The Arduino itself is powered entirely over USB. If you wish to use servos, you'll need to supply an additional 5V through the connector on the shield from the [power board](../power-board.md). There are two red LEDs next to the power input that will turn on if the board is correctly powered.
diff --git a/docs/kit/servo-assembly/ultrasound.md b/docs/kit/servo-assembly/ultrasound.md
@@ -9,7 +9,7 @@ Ultrasound should only be considered accurate up to around two metres, beyond wh
 {{% /notice %}}
 
 ## Wiring up the sensor
-The sensor has four pin connections: ground, 5V (sometimes labelled _vcc_), _trigger_ and _echo_. Most ultrasound sensors will label which pin is which. The ground and 5V should be wired to the ground and 5V pins of the Arduino respectively. The trigger and echo pins should be attached to two different digital IO pins. Take note of these two pins, you'll need them to [use the sensor](/api/arduino#ultrasound-sensors).
+The sensor has four pin connections: ground, 5V (sometimes labelled _vcc_), _trigger_ and _echo_. Most ultrasound sensors will label which pin is which. The ground and 5V should be wired to the ground and 5V pins of the Arduino respectively. The trigger and echo pins should be attached to two different digital IO pins. Take note of these two pins, you'll need them to [use the sensor](../../../api/arduino#ultrasound-sensors).
 
 {{% notice tip %}}
 If the sensor always returns a distance of zero, it means the _trigger_ and _echo_ pins are connected the wrong way! Either change the pin numbers in the code, or swap the connections.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

-Original file line number
+Diff line change
   "version": "1.0.0",
   "description": "",
   "scripts": {
 -    "spellcheck": "mdspell --en-gb --report --ignore-acronyms --ignore-numbers --no-suggestions 'docs/**/*.md'",
 +    "spellcheck": "cspell 'docs/**/*.md'",
     "broken-link-local": "blcl --recursive --ordered --exclude-external ./site/",
     "broken-link-all": "blcl --recursive --exclude farnell --exclude microsoft --exclude https://github.com/sourcebots/docs/tree/master/docs/* --ordered ./site/",
     "test": "npm run spellcheck && npm run broken-link-local",
     "url": "https://github.com/sourcebots/docs/issues"
   },
   "homepage": "https://github.com/sourcebots/docs#readme",
 -  "devDependencies": {},
   "dependencies": {
     "broken-link-checker-local": "0.2.1",
 -    "markdown-spellcheck": "1.3.1"
 +    "cspell": "^6.31.1"
+  }
+}