Merge pull request #1 from Innmind/mkdocs

Build a transverse documentation website of the whole organization via Mkdocs

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: ci
+on:
+  push:
+    branches: [master]
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1 @@
+/.cache

Makefile

@@ -0,0 +1,6 @@
+# This command is intended to be run on your computer
+serve:
+	docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
+
+build:
+	docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build

README.md

@@ -1,15 +1,5 @@
 # Innmind documentation
 
-Most [packages](packages.md) you'll find in this organization are here to advance the organization [vision](vision.md). All of them are designed with the same [principles](design_choices.md) to simplify integration and context switching.
+You can find the built version of this documentation at https://innmind.github.io/documentation/.
 
-You can view the dependencies between the packages via this [macOS application](https://github.com/Innmind/macOS-tooling).
-
-> **Note** However some are here to solve recurring problems you may find in a professional context, or for intellectual curiosity.
-
-## Use cases
-
-- [Upload a local file via HTTP](use_cases/upload_local_file.md)
-- [Copy a local directory to S3](use_cases/copy_local_directory_to_s3.md)
-- [Serve a S3 file via an HTTP server](use_cases/serve_s3_file.md)
-- [Persist a SQL result to a file](use_cases/persist_sql_result_to_file.md)
-- [Persist crawled links to a database](use_cases/persist_crawled_links_to_database.md)
+To view it on your machine, pull the repository and run `make serve` that will open the page http://0.0.0.0:8000/