make the side menu consistent with the contest

JIRA: CI-518

building/project.md

@@ -1,4 +1,4 @@
-# Reference project
+# Reference project repository
 
 The main repository of Phoenix-RTOS is the
 [phoenix-rtos-project](https://github.com/phoenix-rtos/phoenix-rtos-project.git).

devices/interrupts.md

@@ -1,4 +1,4 @@
-# Interrupts
+# Handling interrupts
 
 It is often necessary to handle hardware interrupts when creating a device driver. To enable the userspace server to do
 so, Phoenix-RTOS provides a special callback mechanism. Driver registers interrupt handler via syscall:

hostutils/psdisk.md

@@ -1,4 +1,4 @@
-# psdisk
+# Phoenix disk tool (psdisk)
 
 `psdisk` is a tool responsible for creating a partition table where sources are placed under the following link:
 <https://github.com/phoenix-rtos/phoenix-rtos-filesystems/tree/master/ptable>

index.md

@@ -28,7 +28,10 @@ The ARINC653 execution environment (APEX) is under development.
     3. [Running system on `armv7m7-imxrt106x-evk` (NXP i.MX RT106x)](quickstart/armv7m7-imxrt106x-evk.md)
     4. [Running system on `armv7m7-imxrt117x-evk` (NXP i.MX RT117x)](quickstart/armv7m7-imxrt117x-evk.md)
     5. [Running system on `armv7a7-imx6ull-evk` (NXP i.MX 6ULL)](quickstart/armv7a7-imx6ull-evk.md)
-    6. [Running system on `armv7a9-zynq7000` (Xilinx Zynq 7000)](quickstart/armv7a9-zynq7000.md)
+    6. [Running system on `armv7a9-zynq7000` (Xilinx Zynq 7000)](quickstart/armv7a9-zynq7000/index.md)
+        1. [Running system on `armv7a9-zynq7000-zedboard`](quickstart/armv7a9-zynq7000/armv7a9-zynq7000-zedboard.md)
+        2. [Running system on `armv7a9-zynq7000-zturn`](quickstart/armv7a9-zynq7000/armv7a9-zynq7000-zturn.md)
+        3. [Running system on `armv7a9-zynq7000-qemu`](quickstart/armv7a9-zynq7000/armv7a9-zynq7000-qemu.md)
     7. [Running system on `armv8r52-mps3an536-qemu`](quickstart/armv8r52-mps3an536-qemu.md)
     8. [Running system on `ia32-generic-qemu`](quickstart/ia32-generic-qemu.md)
     9. [Running system on `riscv64-generic-qemu`](quickstart/riscv64-generic-qemu.md)
@@ -47,61 +50,63 @@ The ARINC653 execution environment (APEX) is under development.
         4. [HAL layer for RISC-V 64 based targets](kernel/hal/riscv64.md)
         5. [HAL layer for SPARCv8 LEON based targets](kernel/hal/sparcv8leon.md)
     2. [Processes and threads](kernel/proc/index.md)
-        1. [Processes creation](kernel/proc/forking.md)
-        2. [Synchronization primitives](kernel/proc/sync.md)
-        3. [Message passing](kernel/proc/msg.md)
-        4. [Namespace](kernel/proc/namespace.md)
+        1. [Scheduler](kernel/proc/scheduler.md)
+        2. [Management](kernel/proc/forking.md)
+        3. [Synchronization primitives](kernel/proc/sync.md)
+        4. [Message passing](kernel/proc/msg.md)
+        5. [Namespace](kernel/proc/namespace.md)
     3. [Memory management](kernel/vm/index.md)
         1. [Page allocator](kernel/vm/page.md)
         2. [Memory mapper](kernel/vm/mapper.md)
         3. [Zone allocator](kernel/vm/zalloc.md)
         4. [Fine-grained allocator](kernel/vm/kmalloc.md)
         5. [Memory objects](kernel/vm/objects.md)
     4. [System calls](kernel/syscalls/index.md)
-        1. [Debug (1)](kernel/syscalls/debug.md)
-        2. [Memory management (5)](kernel/syscalls/mem.md)
-        3. [Processes management (13)](kernel/syscalls/proc.md)
-        4. [Threads management (7)](kernel/syscalls/threads.md)
-        5. [Threads synchronization (8)](kernel/syscalls/sync.md)
-        6. [Inter-process communication (12)](kernel/syscalls/ipc.md)
-        7. [File operations (23)](kernel/syscalls/file.md (32))
-        8. [Socket operations (13)](kernel/syscalls/socket.md)
-        9. [Interrupts management (1)](kernel/syscalls/interrupts.md)
-        10. [Performance monitoring (3)](kernel/syscalls/perf.md)
-        11. [Time management (2)](kernel/syscalls/time.md)
-        12. [Platform management (4)](kernel/syscalls/platform.md)
-        13. [RISC-V specific (2)](kernel/syscalls/riscv.md)
+        1. [Debug](kernel/syscalls/debug.md)
+        2. [Memory management](kernel/syscalls/mem.md)
+        3. [Processes management](kernel/syscalls/proc.md)
+        4. [Threads management](kernel/syscalls/threads.md)
+        5. [Threads synchronization](kernel/syscalls/sync.md)
+        6. [Inter-process communication](kernel/syscalls/ipc.md)
+        7. [File operations](kernel/syscalls/file.md)
+        8. [Socket operations](kernel/syscalls/socket.md)
+        9. [Interrupts management](kernel/syscalls/interrupts.md)
+        10. [Performance monitoring](kernel/syscalls/perf.md)
+        11. [Time management](kernel/syscalls/time.md)
+        12. [Platform management](kernel/syscalls/platform.md)
+        13. [RISC-V specific](kernel/syscalls/riscv.md)
     5. [IPC - message queues](kernel/msg/index.md)
     6. [Common routines](kernel/lib.md)
 7. [Standard library](libc/index.md)
     1. [Functions](libc/functions/index.md)
     2. [POSIX emulation server](libc/posix.md)
 8. [Device drivers](devices/index.md)
-    1. [Device server interface](devices/interface.md)
+    1. [Interface](devices/interface.md)
     2. [Accessing hardware](devices/hwaccess.md)
     3. [Handling interrupts](devices/interrupts.md)
     4. [libsdio](devices/libsdio.md)
     5. [Simsensors (Simulating sensors)](devices/sensors/simsensors.md)
-9. [Filesystem servers](filesystems/index.md)
+9. [Filesystems](filesystems/index.md)
 10. [Network stack](lwip/index.md)
+    1. [PPPoU driver](lwip/lwip-pppou.md)
 11. [USB stack](usb/index.md)
     1. [USB Host stack](usb/usbhost.md)
     2. [libusb](usb/libusb.md)
 12. [Utilities](utils/index.md)
-    1. [psh](utils/psh/index.md)
-    2. [psd](utils/psd.md)
+    1. [Phoenix Shell (psh)](utils/psh/index.md)
+    2. [Phoenix Downloader (psd)](utils/psd.md)
 13. [Host utilities](hostutils/index.md)
-    1. [psdisk](hostutils/psdisk.md)
-    2. [psu](hostutils/psu.md)
-    3. [phoenixd](hostutils/phoenixd.md)
+    1. [Phoenix disk tool (psdisk)](hostutils/psdisk.md)
+    2. [Phoenix Serial Uploader (psu)](hostutils/psu.md)
+    3. [Phoenix Server (phoenixd)](hostutils/phoenixd.md)
 14. [Libraries](corelibs/index.md)
-    1. [libcgi](corelibs/libcgi.md)
-    2. [libvirtio](corelibs/libvirtio.md)
-    3. [libvga](corelibs/libvga.md)
-    4. [libgraph](corelibs/libgraph.md)
-    5. [libuuid](corelibs/libuuid.md)
-    6. [libcache](corelibs/libcache.md)
-    7. [libswdg](corelibs/libswdg.md)
+    1. [Common Gateway Interface library (libcgi)](corelibs/libcgi.md)
+    2. [VirtIO library (libvirtio)](corelibs/libvirtio.md)
+    3. [VGA library (libvga)](corelibs/libvga.md)
+    4. [Graphics library (libgraph)](corelibs/libgraph.md)
+    5. [Universally Unique identifiers library (libuuid)](corelibs/libuuid.md)
+    6. [Cache library (libcache)](corelibs/libcache.md)
+    7. [Software watchdog library (libswdg)](corelibs/libswdg.md)
 15. [Ports](ports/index.md)
 16. [Tests and testing process](tests/index.md)
 17. [Coding convention](coding/index.md)

kernel/proc/forking.md

@@ -1,4 +1,4 @@
-# Kernel - Processes and threads - Management
+# Management
 
 Processes are created in Phoenix-RTOS using forking technique. When new process is created the current process
 forks into two processes - parent (process which initializes fork) and child. There are two forking functions

kernel/proc/msg.md

@@ -1,4 +1,4 @@
-# Kernel - Processes and threads - Message passing
+# Message passing
 
 Message passing is the fundamental functionality of the operating system kernel which acts as a basic method of
 interaction between operating system components. Message passing in Phoenix-RTOS is synchronous. Sending thread is

kernel/proc/namespace.md

@@ -1,4 +1,4 @@
-# Kernel - Processes and threads - Namespace
+# Namespace
 
 The namespace and port registering functionality are used by operating system servers
 (e.g. device drivers, file servers) as a basic method of integration with the other operating system components.

kernel/proc/scheduler.md

@@ -1,4 +1,4 @@
-# Kernel - Processes and threads - Scheduler
+# Scheduler
 
 The operating system scheduler controls threads execution with a predetermined policy. It is a part of Phoenix-RTOS
 having the most significant influence on the performance and responsiveness of the whole system.

kernel/proc/sync.md

@@ -1,4 +1,4 @@
-# Kernel - Processes and threads - Synchronization primitives
+# Synchronization primitives
 
 Phoenix-RTOS kernel implements three widely used methods for synchronization of concurrently executed instruction
 streams.

kernel/syscalls/socket.md

@@ -1,4 +1,4 @@
-# Communication sockets
+# Socket operations
 
 ## `syscalls_sockAccept` `(syscalls_sys_accept)`
 

kernel/syscalls/sync.md

@@ -1,4 +1,4 @@
-# Thread synchronization
+# Threads synchronization
 
 ## `syscalls_phMutexCreate`
 

kernel/syscalls/threads.md

@@ -1,4 +1,4 @@
-# Thread management
+# Threads management
 
 ## `syscalls_threadCreate` (`syscalls_beginthread`)
 

kernel/vm/objects.md

@@ -1,4 +1,4 @@
-# Objects
+# Memory objects
 
 Memory objects were introduced to share the physical memory between processes allowing to identify the sets of
 allocated memory pages or segments of physical memory on non-MMU architectures. When process maps object into its memory

libc/posix.md

@@ -1,4 +1,4 @@
-# POSIX emulation
+# POSIX emulation server
 
 The `libphoenix` repository provides POSIX API enabling users to build and run portable POSIX applications. The
 emulation layer is built upon Phoenix-RTOS native messaging API and a dedicated server (`posixsrv`).

quickstart/armv7a9-zynq7000-qemu.md → quickstart/armv7a9-zynq7000/armv7a9-zynq7000-qemu.md

@@ -7,7 +7,7 @@ Note that, the build artifacts, including the system image, should be first prov
 
 If you haven't run the `build.sh` script yet, run it for `armv7a9-zynq7000-qemu` target.
 
-See [how to build the Phoenix-RTOS system image](../building/index.md).
+See [how to build the Phoenix-RTOS system image](../../building/index.md).
 
 ## Running the system image
 
@@ -185,8 +185,8 @@ If you want to quit, you should click on the terminal window, press `ctrl + a`,
 
 ## See also
 
-1. [Running system on armv7a9-zynq7000](armv7a9-zynq7000.md)
+1. [Running system on armv7a9-zynq7000](index.md)
 2. [Running system on armv7a9-zynq7000-zedboard](armv7a9-zynq7000-zedboard.md)
 3. [Running system on armv7a9-zynq7000-zturn](armv7a9-zynq7000-zturn.md)
-4. [Running system on targets](index.md)
-5. [Table of Contents](../index.md)
+4. [Running system on targets](../index.md)
+5. [Table of Contents](../../index.md)

quickstart/armv7a9-zynq7000-zedboard.md → quickstart/armv7a9-zynq7000/armv7a9-zynq7000-zedboard.md

@@ -4,7 +4,7 @@ These instructions describe how to run a Phoenix-RTOS system image for `armv7a9-
 Note that, the build artifacts, including the system image, should be first provided in the `_boot` directory.
 If you haven't run the `build.sh` script yet, run it for `armv7a9-zynq7000-zedboard` target.
 
-See [how to build the Phoenix-RTOS system image](../building/index.md).
+See [how to build the Phoenix-RTOS system image](../../building/index.md).
 
 ## Preparing the board
 
@@ -127,7 +127,7 @@ You want to press the `PS-RST` button (`BTN7`) again and interrupt `Waiting for
 ![Image](_images/zynq7000-plo.png)
 
 If you encountered some problems during this step please see
- [common problems](armv7a9-zynq7000.md#common-problems-on-zynq7000-boards).
+ [common problems](index.md#common-problems-on-zynq7000-boards).
 
 ### Erasing the area intended for file system
 
@@ -272,8 +272,8 @@ top
 
 ## See also
 
-1. [Running system on armv7a9-zynq7000](armv7a9-zynq7000.md)
+1. [Running system on armv7a9-zynq7000](index.md)
 2. [Running system on armv7a9-zynq7000 on emulator](armv7a9-zynq7000-qemu.md)
 3. [Running system on armv7a9-zynq7000-zturn](armv7a9-zynq7000-zturn.md)
-4. [Running system on targets](index.md)
-5. [Table of Contents](../index.md)
+4. [Running system on targets](../index.md)
+5. [Table of Contents](../../index.md)

quickstart/armv7a9-zynq7000-zturn.md → quickstart/armv7a9-zynq7000/armv7a9-zynq7000-zturn.md

@@ -4,7 +4,7 @@ These instructions describe how to run a Phoenix-RTOS system image for `armv7a9-
 Note that, the build artifacts, including the system image, should be first provided in the `_boot` directory.
 If you haven't run the `build.sh` script yet, run it for `armv7a9-zynq7000-zturn` target.
 
-See [how to build the Phoenix-RTOS system image](../building/index.md).
+See [how to build the Phoenix-RTOS system image](../../building/index.md).
 
 ## Preparing the board
 
@@ -135,7 +135,7 @@ sudo ./phoenixd -p /dev/ttyACM0 -b 115200 -s .
 ![Image](_images/zynq7000-zturn-phoenixd.png)
 
 If you encountered some problems during this step please see
-[common problems](armv7a9-zynq7000.md#common-problems-on-zynq7000-boards).
+[common problems](index.md#common-problems-on-zynq7000-boards).
 
 Before flashing, good practice is to erase older file system on flash memory (this is done to avoid errors).
 
@@ -238,8 +238,8 @@ top
 
 ## See also
 
-1. [Running system on armv7a9-zynq7000](armv7a9-zynq7000.md)
+1. [Running system on armv7a9-zynq7000](index.md)
 2. [Running system on armv7a9-zynq7000 on emulator](armv7a9-zynq7000-qemu.md)
 3. [Running system on armv7a9-zynq7000 on Zedboard](armv7a9-zynq7000-zedboard.md)
-4. [Running system on targets](index.md)
-5. [Table of Contents](../index.md)
+4. [Running system on targets](../index.md)
+5. [Table of Contents](../../index.md)

quickstart/armv7a9-zynq7000.md → quickstart/armv7a9-zynq7000/index.md

@@ -40,5 +40,14 @@ from the site below.
 
 ## See also
 
-1. [Running system on targets](index.md)
-2. [Table of Contents](../index.md)
+1. [Running system on targets](../index.md)
+2. [Table of Contents](../../index.md)
+
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+armv7a9-zynq7000-zedboard.md
+armv7a9-zynq7000-zturn.md
+armv7a9-zynq7000-qemu.md
+```

quickstart/index.md

@@ -11,7 +11,7 @@ and building artifacts are available in the `_boot` directory. The building proc
 3. [Running system on armv7m7-imxrt106x-evk (NXP i.MX RT106x)](armv7m7-imxrt106x-evk.md)
 4. [Running system on armv7m7-imxrt117x-evk (NXP i.MX RT117x)](armv7m7-imxrt117x-evk.md)
 5. [Running system on armv7a7-imx6ull-evk (NXP i.MX 6ULL)](armv7a7-imx6ull-evk.md)
-6. [Running system on armv7a9-zynq7000 (Xilinx Zynq 7000)](armv7a9-zynq7000.md)
+6. [Running system on armv7a9-zynq7000 (Xilinx Zynq 7000)](armv7a9-zynq7000/index.md)
 7. [Running system on armv8r52-mps3an536-qemu](armv8r52-mps3an536-qemu.md)
 8. [Running system on ia32-generic-qemu](ia32-generic-qemu.md)
 9. [Running system on riscv64-generic-qemu](riscv64-generic-qemu.md)
@@ -30,10 +30,7 @@ armv7m7-imxrt105x-evk.md
 armv7m7-imxrt106x-evk.md
 armv7m7-imxrt117x-evk.md
 armv7a7-imx6ull-evk.md
-armv7a9-zynq7000.md
-armv7a9-zynq7000-qemu.md
-armv7a9-zynq7000-zedboard.md
-armv7a9-zynq7000-zturn.md
+armv7a9-zynq7000/index.md
 armv8r52-mps3an536-qemu.md
 ia32-generic-qemu.md
 riscv64-generic-qemu.md

tests/index.md

@@ -1,4 +1,4 @@
-# Testing process
+# Tests and testing process
 
 The testing process uses a Phoenix-RTOS testing framework written in Python. The framework provides an environment for
 running both unit and functional tests.