From 2971d6ea0a73ed07eb2c3079e67b085a1a53e3f3 Mon Sep 17 00:00:00 2001 From: Tim Fischer Date: Mon, 9 Sep 2024 21:06:27 +0200 Subject: [PATCH] docs: Initial `docs` directory structure --- docs/floogen/cli.md | 0 docs/floogen/connections.md | 0 docs/floogen/endpoints.md | 0 docs/floogen/known_issues.md | 0 docs/floogen/overview.md | 0 docs/floogen/protocols.md | 0 docs/floogen/routers.md | 0 docs/floogen/routing.md | 0 docs/hw/chimneys.md | 3 +++ docs/hw/common.md | 3 +++ docs/hw/links.md | 3 +++ docs/hw/overview.md | 3 +++ docs/hw/router.md | 3 +++ docs/hw/vips.md | 3 +++ mkdocs.yml | 16 +++++++++++++++- 15 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/floogen/cli.md create mode 100644 docs/floogen/connections.md create mode 100644 docs/floogen/endpoints.md create mode 100644 docs/floogen/known_issues.md create mode 100644 docs/floogen/overview.md create mode 100644 docs/floogen/protocols.md create mode 100644 docs/floogen/routers.md create mode 100644 docs/floogen/routing.md create mode 100644 docs/hw/chimneys.md create mode 100644 docs/hw/common.md create mode 100644 docs/hw/links.md create mode 100644 docs/hw/overview.md create mode 100644 docs/hw/router.md create mode 100644 docs/hw/vips.md diff --git a/docs/floogen/cli.md b/docs/floogen/cli.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/floogen/connections.md b/docs/floogen/connections.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/floogen/endpoints.md b/docs/floogen/endpoints.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/floogen/known_issues.md b/docs/floogen/known_issues.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/floogen/overview.md b/docs/floogen/overview.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/floogen/protocols.md b/docs/floogen/protocols.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/floogen/routers.md b/docs/floogen/routers.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/floogen/routing.md b/docs/floogen/routing.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/hw/chimneys.md b/docs/hw/chimneys.md new file mode 100644 index 00000000..d71478be --- /dev/null +++ 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 new file mode 100644 index 00000000..5d110782 --- /dev/null +++ b/docs/hw/common.md @@ -0,0 +1,3 @@ +# Common IPs + +*TODO* diff --git a/docs/hw/links.md b/docs/hw/links.md new file mode 100644 index 00000000..19c67392 --- /dev/null +++ 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 new file mode 100644 index 00000000..299ac497 --- /dev/null +++ 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 new file mode 100644 index 00000000..ff4f3e83 --- /dev/null +++ b/docs/hw/router.md @@ -0,0 +1,3 @@ +# Routers + +*TODO* diff --git a/docs/hw/vips.md b/docs/hw/vips.md new file mode 100644 index 00000000..ced2cfd7 --- /dev/null +++ b/docs/hw/vips.md @@ -0,0 +1,3 @@ +# Verification IPs (VIPs) of _FlooNoC_ + +*TODO* diff --git a/mkdocs.yml b/mkdocs.yml index c9a6f1e3..fa29866e 100644 --- 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