Fix conflicts in developer docs, converting to markdown where needed

DiamondLightSource · Jan 23, 2024 · 3336027 · 3336027
1 parent 9858749
commit 3336027
Show file tree

Hide file tree

Showing 19 changed files with 20 additions and 423 deletions.
diff --git a/.github/CONTRIBUTING.rst → .github/CONTRIBUTING.md b/.github/CONTRIBUTING.rst → .github/CONTRIBUTING.md
@@ -1,5 +1,4 @@
-Contributing to the project
-===========================
+# Contributing to the project
 
 TODO
 

diff --git a/docs/explanations/decisions.rst b/docs/explanations/decisions.rst
diff --git a/docs/explanations/decisions/0001-record-architecture-decisions.rst b/docs/explanations/decisions/0001-record-architecture-decisions.rst
diff --git a/...ns/0002-switched-to-pip-skeleton.md.jinja → ...ecisions/0002-switched-to-pip-skeleton.md b/...ns/0002-switched-to-pip-skeleton.md.jinja → ...ecisions/0002-switched-to-pip-skeleton.md
@@ -8,7 +8,7 @@ Accepted
 
 ## Context
 
-We should use the following [python_copier_template](https://github.com/DiamondLightSource/python_copier_template).
+We should use the following [python_copier_template](https://github.com/DiamondLightSource/python-copier-template).
 The template will ensure consistency in developer
 environments and package management.
 

diff --git a/docs/explanations/structure.rst → docs/explanations/structure.md b/docs/explanations/structure.rst → docs/explanations/structure.md
@@ -1,49 +1,41 @@
-Skeleton Project Structure
-==========================
+# Skeleton Project Structure
 
 The skeleton project has the following folders at the root level.
 
-src
----
+## src
 
 This folder contains the source code for the project. Typically this
 contains a single folder with the package name for the project and the
 folder contains python modules files.
 
 See `src` for details.
 
-tests
------
+## tests
 
 This folder holds all of the tests that will be run by pytest, both locally
 and in CI.
 
 See `using pytest`
 
-docs
-----
+## docs
 
 This folder contains the source for sphinx documentation.
 
 See `documentation structure` for details.
 
-.github
--------
+## .github
 
 Configuration for the Continuous Integration Workflow on
 github
 
-VSCode specific folders
------------------------
+## VSCode specific folders
 
-.devcontainer
-~~~~~~~~~~~~~
+### .devcontainer
 
 Configuration for running the developer container for this project
 in VSCode.
 
-.vscode
-~~~~~~~
+### .vscode
 
 VSCode settings for this project.
 

diff --git a/docs/how-to/build-docs.rst b/docs/how-to/build-docs.rst
diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md
@@ -1 +1,2 @@
-.. include:: ../../../.github/CONTRIBUTING.md
+```{include} ../../.github/CONTRIBUTING.md
+```
diff --git a/docs/how-to/contribute.rst b/docs/how-to/contribute.rst
diff --git a/docs/how-to/dev-install.rst b/docs/how-to/dev-install.rst
diff --git a/docs/how-to/excalidraw.rst b/docs/how-to/excalidraw.rst
diff --git a/docs/how-to/lint.rst b/docs/how-to/lint.rst
diff --git a/docs/how-to/make-release.rst b/docs/how-to/make-release.rst
diff --git a/docs/how-to/run-tests.rst b/docs/how-to/run-tests.rst
diff --git a/docs/how-to/static-analysis.rst b/docs/how-to/static-analysis.rst