From ffdd47e0f335f39c4cf3aae134e5d057ce6276cc Mon Sep 17 00:00:00 2001 From: lwih Date: Mon, 30 Dec 2024 12:59:50 +0100 Subject: [PATCH] feat: introduce documentation skeleton --- docs/.nojekyll | 0 docs/README.md | 3 +++ docs/_sidebar.md | 4 ++++ docs/concepts/_sidebar.md | 6 ++++++ docs/concepts/fish-env.md | 1 + docs/concepts/index.md | 1 + docs/concepts/main-entities.md | 1 + docs/concepts/missions.md | 1 + docs/concepts/rapportnav-goal.md | 1 + docs/concepts/users.md | 1 + docs/engineering/_sidebar.md | 5 +++++ docs/engineering/auth/index.md | 1 + docs/engineering/backend/index.md | 1 + docs/engineering/frontend/index.md | 1 + docs/engineering/index.md | 1 + docs/engineering/infra/index.md | 1 + docs/guide.md | 0 docs/index.html | 29 +++++++++++++++++++++++++++++ frontend/package.json | 3 ++- 19 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 docs/.nojekyll create mode 100644 docs/README.md create mode 100644 docs/_sidebar.md create mode 100644 docs/concepts/_sidebar.md create mode 100644 docs/concepts/fish-env.md create mode 100644 docs/concepts/index.md create mode 100644 docs/concepts/main-entities.md create mode 100644 docs/concepts/missions.md create mode 100644 docs/concepts/rapportnav-goal.md create mode 100644 docs/concepts/users.md create mode 100644 docs/engineering/_sidebar.md create mode 100644 docs/engineering/auth/index.md create mode 100644 docs/engineering/backend/index.md create mode 100644 docs/engineering/frontend/index.md create mode 100644 docs/engineering/index.md create mode 100644 docs/engineering/infra/index.md create mode 100644 docs/guide.md create mode 100644 docs/index.html diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..821ff607d --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +# RapportNav + +doc homepage diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 000000000..2ff47d97a --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,4 @@ + +* [Home](/) +* [Concepts généraux](concepts/index) +* [Concepts techniques](engineering/index) diff --git a/docs/concepts/_sidebar.md b/docs/concepts/_sidebar.md new file mode 100644 index 000000000..8bb9d2912 --- /dev/null +++ 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 new file mode 100644 index 000000000..31b3b5b59 --- /dev/null +++ b/docs/concepts/fish-env.md @@ -0,0 +1 @@ +fish + env diff --git a/docs/concepts/index.md b/docs/concepts/index.md new file mode 100644 index 000000000..2eae680b0 --- /dev/null +++ b/docs/concepts/index.md @@ -0,0 +1 @@ +index concepts diff --git a/docs/concepts/main-entities.md b/docs/concepts/main-entities.md new file mode 100644 index 000000000..b47c42f84 --- /dev/null +++ b/docs/concepts/main-entities.md @@ -0,0 +1 @@ +main entities diff --git a/docs/concepts/missions.md b/docs/concepts/missions.md new file mode 100644 index 000000000..c16b0570e --- /dev/null +++ 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 new file mode 100644 index 000000000..54a25f057 --- /dev/null +++ b/docs/concepts/rapportnav-goal.md @@ -0,0 +1 @@ +goal diff --git a/docs/concepts/users.md b/docs/concepts/users.md new file mode 100644 index 000000000..cf423833c --- /dev/null +++ b/docs/concepts/users.md @@ -0,0 +1 @@ +users PAM ULAM diff --git a/docs/engineering/_sidebar.md b/docs/engineering/_sidebar.md new file mode 100644 index 000000000..4150f914f --- /dev/null +++ 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 new file mode 100644 index 000000000..5fa1d8144 --- /dev/null +++ b/docs/engineering/auth/index.md @@ -0,0 +1 @@ +auth diff --git a/docs/engineering/backend/index.md b/docs/engineering/backend/index.md new file mode 100644 index 000000000..e34d8c321 --- /dev/null +++ b/docs/engineering/backend/index.md @@ -0,0 +1 @@ +backend diff --git a/docs/engineering/frontend/index.md b/docs/engineering/frontend/index.md new file mode 100644 index 000000000..1097e68b0 --- /dev/null +++ b/docs/engineering/frontend/index.md @@ -0,0 +1 @@ +frontend diff --git a/docs/engineering/index.md b/docs/engineering/index.md new file mode 100644 index 000000000..8d4160ae4 --- /dev/null +++ b/docs/engineering/index.md @@ -0,0 +1 @@ +index tech diff --git a/docs/engineering/infra/index.md b/docs/engineering/infra/index.md new file mode 100644 index 000000000..44edf7ffb --- /dev/null +++ b/docs/engineering/infra/index.md @@ -0,0 +1 @@ +infra diff --git a/docs/guide.md b/docs/guide.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 000000000..d39a740fd --- /dev/null +++ b/docs/index.html @@ -0,0 +1,29 @@ + + + + + Document + + + + + + +
+ + + + + + + diff --git a/frontend/package.json b/frontend/package.json index bb3cfe17c..048940d0a 100644 --- 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",