From cfd8260e49d07dfe5e359b48845b090859e1793f Mon Sep 17 00:00:00 2001
From: Federico Lolli <federico.lolli@skywarder.eu>
Date: Mon, 7 Oct 2024 16:01:55 +0200
Subject: [PATCH] Removed docs directory
Unfinished
---
docs/data.yml | 10 ----------
docs/documentation.typ | 22 ----------------------
docs/functions.typ | 16 ----------------
3 files changed, 48 deletions(-)
delete mode 100644 docs/data.yml
delete mode 100644 docs/documentation.typ
delete mode 100644 docs/functions.typ
diff --git a/docs/data.yml b/docs/data.yml
deleted file mode 100644
index 5aaba77..0000000
--- a/docs/data.yml
+++ /dev/null
@@ -1,10 +0,0 @@
-requirements:
- - MUST have a non-blocking writing (write in a queue and forget)
- - MUST have a blocking reading
- - MUST use f32 types for serial communication
- - MUST provide a baud rate option
- - MUST implent a multithread approach (concurrent write for different ports)
- - MUST use codenames for the ports (and passed as arguments)
- - SHOULD provide a interface with method for open, close, read, write
- - SHOULD provide the same interface of actual serial_bridge C++ implementation
- - MAY use the creates `serial` and `rust_mex`
diff --git a/docs/documentation.typ b/docs/documentation.typ
deleted file mode 100644
index dfa0543..0000000
--- a/docs/documentation.typ
+++ /dev/null
@@ -1,22 +0,0 @@
-#import "functions.typ": requirements_table
-
-// ====== DATA ======
-
-#let data = yaml("data.yml")
-
-#show "MUST": strong
-#show "MUST NOT": strong
-#show "SHOULD": strong
-#show "SHOULD NOT": strong
-#show "MAY": strong
-
-// ====== CONTENT ======
-
-= Requirements
-
-Follow the requirements.
-#requirements_table(data.requirements)
-
-= Design
-
-- state machine?
diff --git a/docs/functions.typ b/docs/functions.typ
deleted file mode 100644
index f037f75..0000000
--- a/docs/functions.typ
+++ /dev/null
@@ -1,16 +0,0 @@
-// === FUNCTIONS ===
-
-#let requirements_table(requirements) = {
- let reqs = ();
- for (i, req) in requirements.enumerate() {
- reqs.push([*R#(i+1)*])
- reqs.push(eval(req, mode: "markup"))
- }
-
- table(
- columns: (auto, 1fr),
- align: (center, left),
- [*ID*], [*Description*],
- ..reqs,
- )
-}
--
GitLab