feat: introduce documentation skeleton

MTES-MCT · Dec 30, 2024 · ffdd47e · ffdd47e
1 parent 5abba35
commit ffdd47e
Show file tree

Hide file tree

Showing 19 changed files with 60 additions and 1 deletion.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+# RapportNav
+
+doc homepage
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,4 @@
+<!-- docs/_sidebar.index.md -->
+* [Home](/)
+* [Concepts généraux](concepts/index)
+* [Concepts techniques](engineering/index)
diff --git a/docs/concepts/_sidebar.md b/docs/concepts/_sidebar.md
@@ -0,0 +1,6 @@
+* [Home](/)
+* [RapportNav](concepts/rapportnav-goal.md)
+* [Utilisateurs](concepts/users.md)
+* [Missions](concepts/missions.md)
+* [Entités à maîtriser](concepts/main-entities.md)
+* [MonitorEnv & MonitorFish](concepts/fish-env.md)
diff --git a/docs/concepts/fish-env.md b/docs/concepts/fish-env.md
@@ -0,0 +1 @@
+fish + env
diff --git a/docs/concepts/index.md b/docs/concepts/index.md
@@ -0,0 +1 @@
+index concepts
diff --git a/docs/concepts/main-entities.md b/docs/concepts/main-entities.md
@@ -0,0 +1 @@
+main entities
diff --git a/docs/concepts/missions.md b/docs/concepts/missions.md
@@ -0,0 +1 @@
+types de missions
diff --git a/docs/concepts/rapportnav-goal.md b/docs/concepts/rapportnav-goal.md
@@ -0,0 +1 @@
+goal
diff --git a/docs/concepts/users.md b/docs/concepts/users.md
@@ -0,0 +1 @@
+users PAM ULAM
diff --git a/docs/engineering/_sidebar.md b/docs/engineering/_sidebar.md
@@ -0,0 +1,5 @@
+* [Home](/)
+* [Authentification](engineering/auth/index)
+* [Frontend](engineering/frontend/index)
+* [Backend](engineering/backend/index)
+* [Infrastructure](engineering/infra/index)
diff --git a/docs/engineering/auth/index.md b/docs/engineering/auth/index.md
@@ -0,0 +1 @@
+auth
diff --git a/docs/engineering/backend/index.md b/docs/engineering/backend/index.md
@@ -0,0 +1 @@
+backend
diff --git a/docs/engineering/frontend/index.md b/docs/engineering/frontend/index.md
@@ -0,0 +1 @@
+frontend
diff --git a/docs/engineering/index.md b/docs/engineering/index.md
@@ -0,0 +1 @@
+index tech
diff --git a/docs/engineering/infra/index.md b/docs/engineering/infra/index.md
@@ -0,0 +1 @@
+infra
diff --git a/docs/guide.md b/docs/guide.md
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <script>
+    window.$docsify = {
+      loadSidebar: true,
+      subMaxLevel: 4
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+</body>
+</html>
diff --git a/frontend/package.json b/frontend/package.json
@@ -16,7 +16,8 @@
     "preview": "vite preview",
     "test": "vitest run src",
     "test:watch": "vitest src",
-    "test:coverage": "vitest run --coverage"
+    "test:coverage": "vitest run --coverage",
+    "docs": "docsify serve docs"
   },
   "dependencies": {
     "@apollo/client": "^3.11.10",