docs: Add quick links to Home

docs/Apache-License.md

@@ -0,0 +1 @@
+../LICENSE-APACHE

docs/SHL-License.md

@@ -0,0 +1 @@
+../LICENSE-SHL

docs/index.md

@@ -2,6 +2,56 @@
 
 _FlooNoC_, is a Network-on-Chip (NoC) research project, which is part of the [PULP (Parallel Ultra-Low Power) Platform](https://pulp-platform.org/). The main idea behind _FlooNoC_ is to provide a scalable high-performance NoC for non-coherent systems. _FlooNoC_ was mainly designed to interface with [AXI4+ATOPs](https://github.com/pulp-platform/axi/tree/master), but can easily be extended to other On-Chip protocols. _FlooNoC_ already provides network interface IPs (named chimneys) for AXI4 protocol, which converts to a custom-link level protocol that provides significantly better scalability than AXI4. _FlooNoC_ also includes protocol-agnostic routers based on the custom link-level protocol to transport payloads. Finally, _FlooNoC_ also include additional NoC components to assemble a complete NoC in a modular fashion. _FlooNoC_ is also highly flexible and supports a wide variety of topologies and routing algorithms. A Network generation framework called _FlooGen_ makes it possible to easily generate entire networks based on a simple configuration file.
 
-## Getting Started
+## Quick Links
 
-Check out our getting started [guide](https://pulp-platform.github.io/FlooNoC/getting_started/)
+<div class="grid cards" markdown>
+
+-   :material-fast-forward:{ .lg .middle } __Setup & Installation__
+
+    ---
+
+    Install Bender for HW IPs and python dependencies for _FlooGen_
+
+    [:octicons-arrow-right-24: Getting started](getting_started.md)
+
+-   :fontawesome-solid-microchip:{ .lg .middle } __Hardware IPs__
+
+    ---
+
+    Check out the documentation of _FlooNoC_ hardware IPs.
+
+    [:octicons-arrow-right-24: Hardware IPs](hw/overview.md)
+
+-   :material-magic-staff:{ .lg .middle } __Network Generation__
+
+    ---
+
+    Learn how to generate a _FlooNoC_ network using _FlooGen_
+
+    [:octicons-arrow-right-24: FlooGen](floogen/overview.md)
+
+-   :material-scale-balance:{ .lg .middle } __Open Source, MIT__
+
+    ---
+
+    _FlooNoC_ is available open-source on [GitHub](https://github.com/pulp-platform/FlooNoC) under permissive licenses.
+
+    [:octicons-arrow-right-24: License](license.md)
+
+-   :material-bookshelf:{ .lg .middle } __Publication__
+
+    ---
+
+    Read the publication of _FlooNoC_.
+
+    [:octicons-arrow-right-24: Publication](https://arxiv.org/abs/2305.08562)
+
+-   :material-file-document:{ .lg .middle } __Changelog__
+
+    ---
+
+    Check out what has changed in the latest version of _FlooNoC_.
+
+    [:octicons-arrow-right-24: Changelog](changelog.md)
+
+</div>

docs/license.md

@@ -0,0 +1,3 @@
+# License
+
+All code checked into this repository is made available under a permissive license. All software sources of _FlooGen_ under `floogen` are licensed under the [Apache License 2.0](Apache-License.md), and all hardware sources in the `hw` folder are licensed under the [Solderpad Hardware License 0.51](SHL-License.md).

mkdocs.yml

@@ -60,11 +60,18 @@ markdown_extensions:
   - pymdownx.superfences
   - pymdownx.tabbed:
       alternate_style: true
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - md_in_html
 
 nav:
 - Home:
   - index.md
   - Repository Structure: repository_structure.md
+  - License: license.md
+  - Contributing: contributing.md
 - Getting Started: getting_started.md
 - Hardware IPs:
   - Overview: hw/overview.md
@@ -75,7 +82,7 @@ nav:
   - Verification IPs: hw/vips.md
 - FlooGen:
   - Overview: floogen/overview.md
-  - Routing: floogen/routing.md
+  - Routing & Topologies: floogen/routing.md
   - Protocols: floogen/protocols.md
   - Endpoints: floogen/endpoints.md
   - Routers: floogen/routers.md