docs: Initial docs directory structure

pulp-platform · Sep 9, 2024 · 2971d6e · 2971d6e
1 parent 9387e1e
commit 2971d6e
Show file tree

Hide file tree

Showing 15 changed files with 33 additions and 1 deletion.
diff --git a/docs/floogen/cli.md b/docs/floogen/cli.md
diff --git a/docs/floogen/connections.md b/docs/floogen/connections.md
diff --git a/docs/floogen/endpoints.md b/docs/floogen/endpoints.md
diff --git a/docs/floogen/known_issues.md b/docs/floogen/known_issues.md
diff --git a/docs/floogen/overview.md b/docs/floogen/overview.md
diff --git a/docs/floogen/protocols.md b/docs/floogen/protocols.md
diff --git a/docs/floogen/routers.md b/docs/floogen/routers.md
diff --git a/docs/floogen/routing.md b/docs/floogen/routing.md
diff --git a/docs/hw/chimneys.md b/docs/hw/chimneys.md
@@ -0,0 +1,3 @@
+# Network interfaces (a.k.a. chimneys)
+
+*TODO*
diff --git a/docs/hw/common.md b/docs/hw/common.md
@@ -0,0 +1,3 @@
+# Common IPs
+
+*TODO*
diff --git a/docs/hw/links.md b/docs/hw/links.md
@@ -0,0 +1,3 @@
+# Link-level protocol
+
+*TODO*
diff --git a/docs/hw/overview.md b/docs/hw/overview.md
@@ -0,0 +1,3 @@
+# Overview of the Hardware Components
+
+*TODO*
diff --git a/docs/hw/router.md b/docs/hw/router.md
@@ -0,0 +1,3 @@
+# Routers
+
+*TODO*
diff --git a/docs/hw/vips.md b/docs/hw/vips.md
@@ -0,0 +1,3 @@
+# Verification IPs (VIPs) of _FlooNoC_
+
+*TODO*
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,5 +22,19 @@ nav:
   - index.md
   - Getting Started: getting_started.md
   - Repository Structure: repository_structure.md
+- Hardware IPs:
+  - Overview: hw/overview.md
+  - Links: hw/links.md
+  - Router: hw/router.md
+  - Network Interfaces: hw/chimneys.md
+  - Common IPs: hw/common.md
+  - Verification IPs: hw/vips.md
 - FlooGen:
-  - floogen.md
+  - Overview: floogen/overview.md
+  - Routing: floogen/routing.md
+  - Protocols: floogen/protocols.md
+  - Endpoints: floogen/endpoints.md
+  - Routers: floogen/routers.md
+  - Connections: floogen/connections.md
+  - CLI: floogen/cli.md
+  - Known Issues: floogen/known_issues.md