Merge pull request #274 from QuTech-Delft/minor-fixes-to-docs

Minor fixes to `docs`
QuTech-Delft · Jan 30, 2025 · 01effbf · 01effbf
2 parents 97ecd70 + 55a8a09
commit 01effbf
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 14 deletions.
diff --git a/docs/api/cpp.md → docs/api/cpp-api.md b/docs/api/cpp.md → docs/api/cpp-api.md
diff --git a/docs/api/emscripten.md → docs/api/emscripten-api.md b/docs/api/emscripten.md → docs/api/emscripten-api.md
diff --git a/docs/api/python.md → docs/api/python-api.md b/docs/api/python.md → docs/api/python-api.md
diff --git a/docs/dev-guide/cpp.md → docs/dev-guide/cpp-dev-guide.md b/docs/dev-guide/cpp.md → docs/dev-guide/cpp-dev-guide.md
diff --git a/docs/dev-guide/dev-guide.md b/docs/dev-guide/dev-guide.md
@@ -77,7 +77,7 @@ conan build . -pr:a=conan/profiles/tests-debug -b missing
 
 !!! note
 
-    - the `conan profile` command only has to be run only once, and not before every build.
+    - the `conan profile` command has to be run only once, and not before every build.
     - the `conan build` command is building libQASM in Debug mode with tests using the `tests-debug` profile.
     - the `-b missing` parameter asks `conan` to build packages from sources
       in case it cannot find the binary packages for the current configuration (platform, OS, compiler, build type...).
@@ -133,7 +133,7 @@ Continuous Integration will fail if the files do not adhere to a series of forma
 - Formatting checks are defined in `.clang-format`.
 - Code style checks are defined in `.clang-tidy`.
 
-It is recommended to run these linters before pushing any change:
+It is recommended to run these linters before pushing any changes:
 
 ```shell
 conan build . -pr:a=conan/profiles/tests-release-gcc-linux-x64 -b missing
@@ -142,11 +142,11 @@ python3 ./scripts/run_cpp_linters.py .
 
 !!! note
 
-    - The linters require`clang-format-18` and `clang-tidy-18`. 
+    - The linters require `clang-format-18` and `clang-tidy-18`. 
     - It is mandatory to have a build before running the linters.
         - `clang-tidy` expects to find a `compile_commands.json` in a build folder.
-    - It is recommended to build with _gcc_ in _Release_ mode.
-        - We have observed `clang-tidy` fails to find some standard headers when compiling with _clang_.
+    - It is recommended to build with `gcc` in Release mode.
+        - We have observed `clang-tidy` fails to find some standard headers when compiling with `clang`.
         - `run_cpp_linters.py` can receive a build folder as second argument, but defaults to `build/Release`.
 
 ## Docker

diff --git a/docs/dev-guide/emscripten.md → docs/dev-guide/emscripten-dev-guide.md b/docs/dev-guide/emscripten.md → docs/dev-guide/emscripten-dev-guide.md
diff --git a/docs/dev-guide/python.md → docs/dev-guide/python-dev-guide.md b/docs/dev-guide/python.md → docs/dev-guide/python-dev-guide.md
diff --git a/docs/user-guide/cpp.md → docs/user-guide/cpp-user-guide.md b/docs/user-guide/cpp.md → docs/user-guide/cpp-user-guide.md
diff --git a/docs/user-guide/emscripten.md → docs/user-guide/emscripten-user-guide.md b/docs/user-guide/emscripten.md → docs/user-guide/emscripten-user-guide.md
diff --git a/docs/user-guide/python.md → docs/user-guide/python-user-guide.md b/docs/user-guide/python.md → docs/user-guide/python-user-guide.md
diff --git a/mkdocs-base.yaml b/mkdocs-base.yaml
@@ -7,19 +7,19 @@ nav:
   - Home: index.md
   - User Guide:
     - User Guide: user-guide/user-guide.md
-    - C++: user-guide/cpp.md
+    - C++: user-guide/cpp-user-guide.md
     - Docker: user-guide/docker.md
-    - Emscripten: user-guide/emscripten.md
-    - Python: user-guide/python.md
+    - Emscripten: user-guide/emscripten-user-guide.md
+    - Python: user-guide/python-user-guide.md
   - Developer Guide:
     - Dev Guide: dev-guide/dev-guide.md
-    - C++: dev-guide/cpp.md
-    - Emscripten: dev-guide/emscripten.md
-    - Python: dev-guide/python.md
+    - C++: dev-guide/cpp-dev-guide.md
+    - Emscripten: dev-guide/emscripten-dev-guide.md
+    - Python: dev-guide/python-dev-guide.md
   - API:
-    - C++: api/cpp.md
-    - Emscripten: api/emscripten.md
-    - Python: api/python.md
+    - C++: api/cpp-api.md
+    - Emscripten: api/emscripten-api.md
+    - Python: api/python-api.md
   - About:
     - Release Notes: about/release-notes.md
     - Contributing: about/contributing.md