docs: fix documentation (#45)

* docs: fix documentation

* docs: readme indentation

Author: Exeloo

.github/ISSUE_TEMPLATE/02-feature_request.yml

@@ -1,13 +1,13 @@
 name: Feature request
 description: Request a new feature
-labels: [enhancement request]
+labels: [enhancement]
 body:
   - type: markdown
     attributes:
       value: |
         Thank you for submitting an idea !
   - type: dropdown
-    id: application_or_command
+    id: command
     attributes:
       label: Which command is this feature request for?
       options:

.github/labeler.yml

@@ -27,3 +27,9 @@ command:start:
       - any-glob-to-any-file:
           - src/command/commands/start.ts
           - src/action/actions/start.ts
+
+documentation:
+  - changed-files:
+      - any-glob-to-any-file:
+          - docs/*
+          - docs/**/*

.github/workflows/push-docs.yml

@@ -1,9 +1,11 @@
-name: synchronize-docs
+name: Synchronize Docs
 
 on:
   push:
     branches:
       - main
+    paths:
+      - "docs/**"
   workflow_dispatch:
 
 jobs:

README.md

@@ -1,15 +1,17 @@
 <div align="center">
-	<br />
-	<p>
-		<a href="https://github.com/NanoForge-dev"><img src="https://github.com/NanoForge-dev/CLI/blob/main/.github/logo.png" width="546" alt="NanoForge" /></a>
-	</p>
-	<br />
-	<p>
-		<a href="https://github.com/NanoForge-dev/CLI/actions"><img src="https://github.com/NanoForge-dev/CLI/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
-		<a href="https://github.com/NanoForge-dev/CLI/commits/main"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/CLI.svg?logo=github&logoColor=ffffff" alt="Last commit." /></a>
-		<a href="https://github.com/NanoForge-dev/CLI/graphs/contributors"><img src="https://img.shields.io/github/contributors/NanoForge-dev/CLI.svg?maxAge=3600&logo=github&logoColor=fff&color=00c7be" alt="contributors" /></a>
-		<a href="https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml"><img src="https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml/badge.svg" alt="Documentation status" /></a>
-	</p>
+    <br />
+    <p>
+        <a href="https://github.com/NanoForge-dev"><img src="https://github.com/NanoForge-dev/CLI/blob/main/.github/logo.png" width="546" alt="NanoForge" /></a>
+    </p>
+    <br />
+    <p>
+        <a href="https://www.npmjs.com/package/@nanoforge-dev/cli"><img src="https://img.shields.io/npm/v/@nanoforge-dev/cli.svg?maxAge=3600" alt="npm version" /></a>
+        <a href="https://www.npmjs.com/package/@nanoforge-dev/cli"><img src="https://img.shields.io/npm/dt/@nanoforge-dev/cli.svg?maxAge=3600" alt="npm downloads" /></a>
+        <a href="https://github.com/NanoForge-dev/CLI/actions/workflows/tests.yml"><img src="https://github.com/NanoForge-dev/CLI/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
+        <a href="https://github.com/NanoForge-dev/CLI/actions/workflows/push-docs.yml"><img src="https://github.com/NanoForge-dev/CLI/actions/workflows/push-docs.yml/badge.svg" alt="Documentation status" /></a>
+        <a href="https://github.com/NanoForge-dev/CLI/commits/main"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/CLI.svg?logo=github&logoColor=ffffff" alt="Last commit" /></a>
+        <a href="https://github.com/NanoForge-dev/CLI/graphs/contributors"><img src="https://img.shields.io/github/contributors/NanoForge-dev/CLI.svg?maxAge=3600&logo=github&logoColor=fff&color=00c7be" alt="Contributors" /></a>
+    </p>
 </div>
 
 ## About
@@ -31,6 +33,7 @@ And then create a new project :
 ```bash
 nf new
 ```
+
 ## Documentation
 
 The documentation for nanoforge cli can be found at : [https://nanoforge-dev.github.io/docs/cli](https://nanoforge-dev.github.io/docs/cli)

docs/build-config.schema.json

@@ -11,7 +11,7 @@
     "outDir": {
       "type": "string",
       "description": "the directory where to put the built files"
-    },
+    }
   },
   "required": ["entryFile", "outDir"]
 }

docs/client-config.schema.json

@@ -13,7 +13,7 @@
     },
     "build": {
       "$ref": "https://nanoforge-dev.github.io/docs/cli/build-config.schema.json"
-    },    
+    },
     "runtime": {
       "$ref": "https://nanoforge-dev.github.io/docs/cli/run-config.schema.json"
     }

docs/config.schema.json

@@ -16,7 +16,7 @@
     },
     "client": {
       "$ref": "https://nanoforge-dev.github.io/docs/cli/client-config.schema.json"
-    },    
+    },
     "server": {
       "$ref": "https://nanoforge-dev.github.io/docs/cli/server-config.schema.json"
     }

docs/run-config.schema.json

@@ -7,7 +7,7 @@
     "dir": {
       "type": "string",
       "description": "the directory to use"
-    },
+    }
   },
   "required": ["dir"]
 }

docs/server-config.schema.json

@@ -13,7 +13,7 @@
     },
     "build": {
       "$ref": "https://nanoforge-dev.github.io/docs/cli/build-config.schema.json"
-    },    
+    },
     "runtime": {
       "$ref": "https://nanoforge-dev.github.io/docs/cli/run-config.schema.json"
     }