From 51c7833fa802090173b7ec5294c62c6179f857f7 Mon Sep 17 00:00:00 2001 From: Olof Kindgren Date: Wed, 14 Feb 2024 20:45:04 +0100 Subject: [PATCH] Refactor docs --- doc/datasheet.rst | 5 +++++ doc/index.rst | 11 ++++++----- doc/internals.rst | 5 +++++ doc/reservoir.rst | 9 +++++++++ doc/servant.rst | 10 ++++++---- 5 files changed, 31 insertions(+), 9 deletions(-) create mode 100644 doc/datasheet.rst create mode 100644 doc/internals.rst create mode 100644 doc/reservoir.rst diff --git a/doc/datasheet.rst b/doc/datasheet.rst new file mode 100644 index 0000000..a9e8d89 --- /dev/null +++ b/doc/datasheet.rst @@ -0,0 +1,5 @@ +********* +Datasheet +********* + +.. include:: interface.rst diff --git a/doc/index.rst b/doc/index.rst index ea16812..227c8ff 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,12 +1,13 @@ +################ SERV user manual -================ +################ Welcome to the user manual of the award-winning SERV, the world's smallest RISC-V CPU. .. toctree:: - :maxdepth: 3 + :maxdepth: 4 :caption: Contents: - interface.rst - modules.rst - servant.rst + datasheet.rst + internals.rst + reservoir.rst diff --git a/doc/internals.rst b/doc/internals.rst new file mode 100644 index 0000000..a78df95 --- /dev/null +++ b/doc/internals.rst @@ -0,0 +1,5 @@ +********* +Internals +********* + +.. include:: modules.rst diff --git a/doc/reservoir.rst b/doc/reservoir.rst new file mode 100644 index 0000000..7d19020 --- /dev/null +++ b/doc/reservoir.rst @@ -0,0 +1,9 @@ +************************** +Building systems with SERV +************************** + +A CPU is only as good as its eosystem. In order to make use of SERV, it needs to be combined with other components such as memories, accelerators and peripheral controllers. + +Welcome to the reservoir, a pool of ready-made designs and subsystems for different purpsoses that you can use to quickly get started with SERV or integrate it into larger designs. + +.. include:: servant.rst diff --git a/doc/servant.rst b/doc/servant.rst index 39ce7ef..61ab8e2 100644 --- a/doc/servant.rst +++ b/doc/servant.rst @@ -1,10 +1,12 @@ -Reference platform -================== +Servant : FPGA Reference platform +================================= + +.. figure:: servant.png + + Servant FPGA Reference platform SERV comes with a small FPGA-focused reference platform called Servant, which is capable of running Zephyr RTOS, the regression test suite and other software. The platform consists of SERV, a timer, memory and a 1-bit GPIO output pin. -.. image:: servant.png - Available targets -----------------