Add docs

.github/workflows/deploy-docs-test.yml

@@ -0,0 +1,36 @@
+name: Test deployment of fdm-docs
+
+defaults:
+  run:
+    working-directory: ./fdm-docs
+
+on:
+  pull_request:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.12.2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Build website
+        run: pnpm build

.github/workflows/deploy-docs.yml

@@ -0,0 +1,61 @@
+name: Deploy to fdm-docs GitHub Pages
+
+defaults:
+  run:
+    working-directory: ./fdm-docs
+
+on:
+  push:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.12.2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Build website
+        run: pnpm build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,5 +1,6 @@
-# fdm: Analyze farm data in a structured way
+# FDM: Transforming Farm Data into Actionable Insights
 
+![Logo of FDM](/fdm-docs/static/img/fdm-high-resolution-logo.png)
 
 ## Contact
 * Maintainer: @SvenVw

fdm-docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

fdm-docs/CHANGELOG.md

@@ -0,0 +1,7 @@
+# fdm-docs
+
+## 0.1.0
+
+### Minor Changes
+
+- Setup a documentation website for fdm

fdm-docs/README.md

@@ -0,0 +1,21 @@
+# fdm-docs
+
+This folder contains the source code of the website for fdm. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Development
+
+As part of the the `fdm` monorepu you can use turbo tasks for development:
+
+```
+# Install the packages required
+$ pnpm install
+
+# Start local development
+$ turbo run watch-docs
+
+# Build the website
+$ turbo run build
+```
+
+## Contact
+* Maintainer: @SvenVw

fdm-docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

fdm-docs/blog/2024-10-22-first-blog-post.mdx

@@ -0,0 +1,8 @@
+---
+slug: first-blog-post
+title: First blog post
+authors: [svenverweij]
+tags: [hello]
+---
+
+A first blog post to test the blog feature

fdm-docs/blog/authors.yml

@@ -0,0 +1,9 @@
+svenverweij:
+  name: Sven Verweij
+  title: Project Manager @ NMI
+  url: https://github.com/SvenVw
+  image_url: https://github.com/SvenVw.png
+  page: true
+  socials:
+    linkedin: sven-verweij
+    github: SvenVw

fdm-docs/blog/tags.yml

@@ -0,0 +1,4 @@
+hello:
+  label: Hello
+  permalink: /hello
+  description: Hello tag description

fdm-docs/docs/intro.md

@@ -0,0 +1,10 @@
+---
+sidebar_position: 1
+---
+
+# Tutorial Intro
+
+Let's discover **fdm in less than 5 minutes**.
+
+## TODO
+Write a tuturial for using `fdm`

fdm-docs/docs/tutorial-advanced/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Tutorial - Advanced",
+  "position": 3,
+  "link": {
+    "type": "generated-index"
+  }
+}

fdm-docs/docs/tutorial-advanced/add-custom-fertilizer.md

@@ -0,0 +1,8 @@
+---
+sidebar_position: 1
+---
+
+# Add a custom fertilizer
+
+Let's add a custom fertilizer
+

fdm-docs/docs/tutorial-basics/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Tutorial - Storing data in fdm",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Learn how to store farm data in a structured way using fdm"
+  }
+}

fdm-docs/docs/tutorial-basics/adding-a-farm.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Add a farm
+
+A farm is an asset that can be linked to various assets like, fields and fertilizers

fdm-docs/docs/tutorial-concepts/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Tutorial - Concepts",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "5 minutes to learn the most important fdm concepts."
+  }
+}

fdm-docs/docs/tutorial-concepts/asset-action-model.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Asset Action Model
+
+`fdm` uses an Asset-Action model to store data at a farm.

fdm-docs/docs/tutorial-concepts/schema.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 2
+---
+
+# Schema
+
+The data schema of fdm looks like this: