From b473a95c3653ace462091ed03cc790436dbaf621 Mon Sep 17 00:00:00 2001
From: Shaun Hamilton <shauhami020@gmail.com>
Date: Mon, 12 Feb 2024 12:18:11 +0200
Subject: [PATCH] add to docs

---
 docs/src/plugin-system.md  |  8 ++++++--
 docs/src/project-syntax.md |  2 +-
 docs/src/roadmap.md        |  1 -
 docs/theme/css/general.css | 20 ++++++++++++--------
 4 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/docs/src/plugin-system.md b/docs/src/plugin-system.md
index 18f6fb58..09f91970 100644
--- a/docs/src/plugin-system.md
+++ b/docs/src/plugin-system.md
@@ -53,7 +53,11 @@ The `title` and `description` fields are expected to be either plain strings, or
 
 ### `getLesson`
 
-```ts
+```admonish attention
+This function can be called multiple times per lesson. Therefore, it is expected to be <dfn title="An operation that can be applied multiple times without changing the result after the initial application.">idempotent</dfn>.
+```
+
+```typescript
 (projectDashedName: string, lessonNumber: number) =>
   Promise<{
     description: string;
@@ -78,7 +82,7 @@ The `seed[].filePath` field is the relative path to the file from the workspace
 
 The `seed[]` field can also be a plain string, which is then treated as a `bash` command to be run in the workspace root.
 
-An example of this can be seen in the default parser used: https://github.com/freeCodeCamp/freeCodeCampOS/blob/main/.freeCodeCamp/plugin/index.js
+An example of this can be seen in the default parser used: <https://github.com/freeCodeCamp/freeCodeCampOS/blob/main/.freeCodeCamp/plugin/index.js>
 
 ## Example
 
diff --git a/docs/src/project-syntax.md b/docs/src/project-syntax.md
index acff302e..3d105d55 100644
--- a/docs/src/project-syntax.md
+++ b/docs/src/project-syntax.md
@@ -1,6 +1,6 @@
 # Project Syntax
 
-This is the Markdown syntax used to create projects in the curriculum.
+This is the Markdown syntax used to create projects in the curriculum using the default parser. The parser can be configured using the [plugin-system](./plugin-system.md).
 
 ## Markers
 
diff --git a/docs/src/roadmap.md b/docs/src/roadmap.md
index 173a4008..5b12b98f 100644
--- a/docs/src/roadmap.md
+++ b/docs/src/roadmap.md
@@ -8,4 +8,3 @@ For the most part, this roadmap outlines todos for `freecodecamp-os`. If this ro
 
 - [ ] Loader to show progress of "Reset Step"
 - [ ] Crowdin translation integration
-  - Possibly, this will include UI to select available languages
diff --git a/docs/theme/css/general.css b/docs/theme/css/general.css
index 1ac74757..290c15a9 100644
--- a/docs/theme/css/general.css
+++ b/docs/theme/css/general.css
@@ -100,15 +100,15 @@ h6:target::before {
 .page {
   outline: 0;
   padding: 0 var(--page-padding);
-  margin-top: calc(
-    0px - var(--menu-bar-height)
-  ); /* Compensate for the #menu-bar-hover-placeholder */
+  margin-top: calc(0px - var(--menu-bar-height));
+  /* Compensate for the #menu-bar-hover-placeholder */
 }
 .page-wrapper {
   box-sizing: border-box;
 }
 .js:not(.sidebar-resizing) .page-wrapper {
-  transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+  transition: margin-left 0.3s ease, transform 0.3s ease;
+  /* Animation: slide away */
 }
 
 .content {
@@ -213,10 +213,10 @@ kbd {
   visibility: hidden;
   color: #fff;
   background-color: #333;
-  transform: translateX(
-    -50%
-  ); /* Center by moving tooltip 50% of its width left */
-  left: -8px; /* Half of the width of the icon */
+  transform: translateX(-50%);
+  /* Center by moving tooltip 50% of its width left */
+  left: -8px;
+  /* Half of the width of the icon */
   top: -35px;
   font-size: 0.8em;
   text-align: center;
@@ -238,3 +238,7 @@ kbd {
 .result-no-output {
   font-style: italic;
 }
+
+dfn[title] {
+  text-decoration: underline dotted;
+}
\ No newline at end of file