docs: lint and format (#237)

.docs/.eslintignore

@@ -0,0 +1,4 @@
+dist
+node_modules
+.output
+.nuxt

.docs/.eslintrc

@@ -0,0 +1,19 @@
+{
+  "root": true,
+  "extends": "@nuxtjs/eslint-config-typescript",
+  "rules": {
+    "vue/multi-word-component-names": [
+      0
+    ],
+    "vue/no-multiple-template-root": [
+      0
+    ],
+    "vue/no-restricted-syntax": [
+      "error",
+      {
+        "selector": "VElement[name='a']",
+        "message": "Use NuxtLink instead."
+      }
+    ]
+  }
+}

.docs/.gitignore

@@ -10,3 +10,4 @@ dist
 sw.*
 .env
 .output
+.eslintcache

.docs/.markdownlint.yml

@@ -0,0 +1,18 @@
+# Default state for all rules
+default: true
+# Disable max line length
+MD013: false
+# Disable space after hash on atx style heading
+MD018: false
+# Allow duplicated heading for different sections
+MD024:
+  allow_different_nesting: true
+  siblings_only: true
+# Allow multiple top-level headings
+MD025: false
+# Allow inline HTML
+MD033: false
+# Allow non blank lines around list
+MD032: false
+MD046:
+  style: fenced

.docs/.markdownlintignore

@@ -0,0 +1,3 @@
+**/node_modules
+
+content/0.index.md

.docs/README.md

@@ -1,3 +1,5 @@
+<!-- @case-police-ignore Api -->
+
 # ArmoniK.Api Docs
 
 Docs for ArmoniK.Api
@@ -13,11 +15,13 @@ npm install
 ## Usage
 
 To run the docs locally, run the following command:
+
 ```bash
 npm run dev
 ```
 
 To build the docs, run the following command:
+
 ```bash
 npm run generate
 ```

.docs/app.config.ts

@@ -1,14 +1,14 @@
 export default defineAppConfig({
   docus: {
-    title: "ArmoniK.Api",
-    description: "API for ArmoniK",
+    title: 'ArmoniK.Api',
+    description: 'API for ArmoniK',
     socials: {
-      github: 'aneoconsulting/ArmoniK.Api',
+      github: 'aneoconsulting/ArmoniK.Api'
     },
     github: {
       dir: '.docs/content',
       repo: 'ArmoniK.Api',
-      owner: 'aneoconsulting',
-    },
+      owner: 'aneoconsulting'
+    }
   }
-});
+})

.docs/content/0.index.md

@@ -5,6 +5,8 @@ layout: page
 main.fluid: false
 ---
 
+<!-- @case-police-ignore Api -->
+
 ::block-hero
 ---
 cta:

.docs/content/1.guide/0.index.md

@@ -1,3 +1,3 @@
 # Get started
 
-Let's get started with ArmoniK Api.
+Let's get started with ArmoniK API.

.docs/content/1.guide/1.packages/0.index.md

@@ -2,6 +2,8 @@
 navigation.icon: heroicons:magnifying-glass
 ---
 
+<!-- @case-police-ignore Api -->
+
 # Find your package
 
 The ArmoniK Team provides a set of packages generated on top the ArmoniK Api to help you to build your application.
@@ -22,7 +24,7 @@ The ArmoniK Team provides a set of packages generated on top the ArmoniK Api to
 - [armonik](https://pypi.org/project/armonik/)
 ::
 
-## Javascript packages
+## JavaScript packages
 
 ::list{type="primary"}
 - [@aneoconsultingfr/armonik.api](https://www.npmjs.com/package/@aneoconsultingfr/armonik.api)

.docs/content/1.guide/1.packages/1.c-sharp.md

@@ -2,30 +2,39 @@
 navigation.icon: vscode-icons:file-type-csharp2
 ---
 
+<!-- @case-police-ignore Api -->
+
 # C# packages
 
 This page lists the namespaces in the C# projects of this repository.
 In each namespace, the included classes are available.
 
 ## ArmoniK.Api.Client.Options
+
 In this namespace, there are options classes to configure the client connection to ArmoniK control plane.
 
 ## ArmoniK.Api.Client.Submitter
+
 This namespace includes some utilitarian classes for interaction with ArmoniK control plane.
 It also contains the generated gRPC classes built from the protobuf files related to the client to ArmoniK control plane.
 
 ## ArmoniK.Api.Common.Channel.Utils, ArmoniK.Api.Common.Options
-They contain some classes to create and configure (though options) Grpc Channels between ArmoniK workers and polling agents.
+
+They contain some classes to create and configure (though options) gRPC Channels between ArmoniK workers and polling agents.
 
 ## ArmoniK.Api.Core
+
 It includes the generated gRPC classes built from the protobuf files used by [ArmoniK.Core](https://github.com/aneoconsulting/ArmoniK.Core).
 
 ## ArmoniK.Api.Common.Utils
+
 It contains helpers that are widely used in ArmoniK.
 
 ## ArmoniK.Api.Worker.Tests
+
 This namespace contains the test classes for the worker.
 
 ## ArmoniK.Api.Worker.Worker, ArmoniK.Api.Worker.Utils
+
 They contain helper classes to create a .Net 6 worker that implements ArmoniK interfaces and executes the computations submitted to the control plane.
 It also includes the generated gRPC classes built from the protobuf files used by the workers that execute the computations.

.docs/content/1.guide/1.packages/4.web.md

@@ -8,7 +8,6 @@ The TypeScript package is build on top of [ts-proto](https://www.npmjs.com/packa
 
 This package does not include any gRPC client or server implementation. You can use it to build a custom client or app.
 
-
 ## Update Web Package
 
 Nothing to do here. The TypeScript package is automatically updated by the CI/CD pipeline when a new release is published.

.docs/content/1.guide/2.releases.md

@@ -2,6 +2,8 @@
 navigation.icon: heroicons:newspaper
 ---
 
+<!-- @case-police-ignore Api -->
+
 # Releases
 
 A release is created when there is enough new features or bug fixes to justify a new version. A release is created from the `main` branch and is tagged with the version number following [Semantic Versioning](https://semver.org/).
@@ -46,7 +48,7 @@ After each commit is merged into the `main` branch, packages are built and deplo
 
 The build and publishing method and quality of edge releases are the same as stable ones. The only difference is that you should often check the GitHub repository for updates. There is a slight change of regressions not being caught during the review process and by the automated tests. Therefore, we internally use this channel to double-check everything before each release.
 
-### C#
+### C# packages
 
 C# packages are available on [NuGet](https://www.nuget.org).
 

.docs/nuxt.config.ts

@@ -1,25 +1,25 @@
-const baseURL = process.env.NODE_ENV === "production" ? "/ArmoniK.Api/" : "/";
+const baseURL = process.env.NODE_ENV === 'production' ? '/ArmoniK.Api/' : '/'
 
 export default defineNuxtConfig({
   app: {
-    baseURL: baseURL,
+    baseURL,
     head: {
       link: [
         {
           rel: 'icon',
           type: 'image/ico',
-          href: `${baseURL}favicon.ico`,
+          href: `${baseURL}favicon.ico`
         }
       ]
     }
   },
 
-  extends: "@aneoconsultingfr/armonik-docs-theme",
+  extends: '@aneoconsultingfr/armonik-docs-theme',
 
   runtimeConfig: {
     public: {
       siteName: 'ArmoniK.Api',
-      siteDescription: 'API for ArmoniK',
+      siteDescription: 'API for ArmoniK'
     }
-  },
-});
+  }
+})

.docs/package.json

@@ -2,16 +2,26 @@
   "name": "armonik-api-docs",
   "version": "0.1.0",
   "private": true,
-  "packageManager": "pnpm@8.1.0",
+  "packageManager": "pnpm@8.4.0",
   "scripts": {
+    "prepare": "nuxi prepare",
     "dev": "nuxi dev",
     "build": "nuxi build",
     "generate": "nuxi generate",
-    "preview": "nuxi preview"
+    "preview": "nuxi preview",
+    "lint": "eslint --cache .",
+    "lint:fix": "eslint --cache --fix .",
+    "lint:md": "markdownlint . && case-police ./**/*.md",
+    "lint:md:fix": "markdownlint . --fix && case-police --fix ./**/*.md"
   },
   "dependencies": {
-    "@aneoconsultingfr/armonik-docs-theme": "^0.6.0",
-    "nuxt": "^3.3.1",
-    "rollup": "3.18.0"
+    "@aneoconsultingfr/armonik-docs-theme": "^0.6.9",
+    "nuxt": "^3.4.3"
+  },
+  "devDependencies": {
+    "@nuxtjs/eslint-config-typescript": "^12.0.0",
+    "case-police": "^0.6.0",
+    "eslint": "^8.40.0",
+    "markdownlint-cli": "^0.34.0"
   }
 }