openrisc · ChenMiaoi · Sep 2, 2025 · stffrdhrn · Sep 3, 2025 · stffrdhrn
diff --git a/_config.yml b/_config.yml
@@ -3,4 +3,7 @@ theme: just-the-docs
 color_scheme: or1k
 repository: openrisc/tutorials
 
-include: ['debugging', 'de0_nano', 'docs', 'or1ksim', 'platform', 'sw']
+include: [
+  'pages',
+  'resouce',
+]
diff --git a/de0_nano/.gitignore b/de0_nano/.gitignore
diff --git a/index.md b/index.md
@@ -78,8 +78,8 @@ or1k_interrupts_disable(void)
 }
 ```
 
-See the [newlib tutorial](newlib.html) for details on how to setup the newlib development
-environment.  Or checkout the [Quickstart tutorial](images.html) for docker images
+See the [newlib tutorial](./pages/toolchains/newlib.html) for details on how to setup the newlib development
+environment.  Or checkout the [Quickstart tutorial](./pages/quick_start.html) for docker images
 that have the newlib environment out of the box.
 
 ## Tools (partially required)
@@ -92,8 +92,8 @@ OpenRISC. You can install it as described
 
 Featured in:
 
- * [De0 Nano](de0_nano/) - De0 Nano FPGA development board platform tutorial.
- * [Quickstart Images](images.html) - Docker verilog development environment
+ * [De0 Nano](./pages/platforms/fusesoc/) - De0 Nano FPGA development board platform tutorial.
+ * [Quickstart Images](./pages/quick_start.html) - Docker verilog development environment
 
 ### OpenOCD
 
@@ -103,8 +103,8 @@ install a current version.
 
 Featured in:
 
- * [De0 Nano](de0_nano/) - De0 Nano FPGA development board platform tutorial.
- * [Debugging](docs/Debugging.html) - OpenOCD debugging cheat sheet.
+ * [De0 Nano](./pages/platforms/fusesoc/) - De0 Nano FPGA development board platform tutorial.
+ * [Debugging](./pages/platforms/debugging.html) - OpenOCD debugging cheat sheet.
 
 ### Quartus Prime
 
@@ -115,7 +115,7 @@ required for some tutorials.
 
 Featured in:
 
- * [De0 Nano](de0_nano/) - De0 Nano FPGA development board platform tutorial.
+ * [De0 Nano](./pages/platforms/fusesoc/) - De0 Nano FPGA development board platform tutorial.
 
 For downloading the free version, visit the
 [Intel website](https://www.intel.com/content/www/us/en/software-kit/849769/intel-quartus-prime-lite-edition-design-software-version-24-1-for-linux.html) and

diff --git a/tutorials.md → pages/futher_reading.md b/tutorials.md → pages/futher_reading.md
diff --git a/docs/linux-on-or1ksim.md → pages/linux/linux-on-or1ksim.md b/docs/linux-on-or1ksim.md → pages/linux/linux-on-or1ksim.md
diff --git a/docs/linux-on-qemu.md → pages/linux/linux-on-qemu.md b/docs/linux-on-qemu.md → pages/linux/linux-on-qemu.md
diff --git a/docs/Linux.md → pages/linux/linux.md b/docs/Linux.md → pages/linux/linux.md
@@ -76,5 +76,5 @@ halt; load_image vmlinux; reg r3 0; reg npc 0x100; resume
 The kernel image is now available as an elf file called `vmlinux`. This file can be used as any other bare-metal program for OpenRISC. To test the Linux image, you can:
 * Run it in the reference C simulator (or1ksim)
 * Run it on a simulated RTL model (Most likely extremely slow, unless using verilator)
-* [Load it to RAM on an FPGA board with a debugger](Debugging.html)
+* [Load it to RAM on an FPGA board with a debugger](../platforms/debugging.html)
 * Program it to non-volatile flash on an FPGA board
diff --git a/docs/Debugging.md → pages/platforms/debugging.md b/docs/Debugging.md → pages/platforms/debugging.md
diff --git a/fusesoc.md → pages/platforms/fusesoc.md b/fusesoc.md → pages/platforms/fusesoc.md
@@ -7,7 +7,7 @@ parent: Platforms
 
 The FuseSoC build system, dependency manager and fpga integration platform
 allows for easy creation of OpenRISC systems.  If is featured in our
-[Quick Start with Docker Images](images/) as our main fpga development
+[Quick Start with Docker Images](../quick_start.html) as our main fpga development
 platform.  For in depth documentation see:
 
  * [FuseSoC Manual](https://fusesoc.readthedocs.io/en/stable/index.html) - Full documentation.

diff --git a/de0_nano/index.md → pages/platforms/fusesoc/de0_nano.md b/de0_nano/index.md → pages/platforms/fusesoc/de0_nano.md
@@ -13,12 +13,12 @@ parent: FuseSoC
  * OpenOCD
  * The quartus FPGA design software
  * `fusesoc` - The [FuseSoC build system](../fusesoc.html).
- * `or1k-elf-` Toolchain as installed in our [newlib tutorial](../newlib.html).
+ * `or1k-elf-` Toolchain as installed in our [newlib tutorial](../../toolchains/newlib.html).
 
 #### Files
 
- * [hello.c](../sw/hello/hello.c) - A Hello World test program.
- * [timer.c](../sw/timer/timer.c) - A baremetal example using the OpenRISC timer api's provided by newlib.
+ * [hello.c](../../../resource/de0_nano/sw/hello/hello.c) - A Hello World test program.
+ * [timer.c](../../../resource/de0_nano/sw/timer/timer.c) - A baremetal example using the OpenRISC timer api's provided by newlib.
 
 ## DE0 Nano
 
@@ -46,7 +46,7 @@ computer. If you want to use UART, an extra dongle is needed. Any
 USB-UART adapter can be used. You need to connect it to the header on
 the bottom of the board as depicted below.
 
-![uart](doc/uart.png "Connect UART to board")
+![uart](../../../resource/images/uart.png "Connect UART to board")
 
 ### Setup the Environment
 

diff --git a/or1ksim/index.md → pages/platforms/or1ksim.md b/or1ksim/index.md → pages/platforms/or1ksim.md
@@ -16,9 +16,9 @@ nav_order: 2
 
 We will download these below.
 
- - [or1ksim.cfg](or1ksim.cfg) - config needed for or1ksim
- - [hello.c](../sw/hello/hello.c) - hello world program
- - [timer.c](../sw/timer/timer.c) - timer program
+ - [or1ksim.cfg](../../resouce/or1ksim/or1ksim.cfg) - config needed for or1ksim
+ - [hello.c](../../resouce/de0_nano/sw/hello/hello.c) - hello world program
+ - [timer.c](../../resouce/de0_nano/sw/timer/timer.c) - timer program
  - [or1ksim-2025-04-27.tar.gz](https://github.com/openrisc/or1ksim/releases/download/2025-04-27/or1ksim-2025-04-27.tar.gz) - The OpenRISC simulator
 
 # or1ksim Tutorial
@@ -188,7 +188,7 @@ A second elapsed
 
 ## Next steps
 
-Also checkout our tutorial on how to run [Linux on or1ksim](../docs/linux-on-or1ksim.html).
+Also checkout our tutorial on how to run [Linux on or1ksim](../linux/linux-on-or1ksim.html).
 
 ## Further Reading
 

diff --git a/platforms.md → pages/platforms/platforms.md b/platforms.md → pages/platforms/platforms.md
diff --git a/platform/qemu.md → pages/platforms/qemu.md b/platform/qemu.md → pages/platforms/qemu.md
diff --git a/images.md → pages/quick_start.md b/images.md → pages/quick_start.md
diff --git a/glibc.md → pages/toolchains/glibc.md b/glibc.md → pages/toolchains/glibc.md
diff --git a/musl.md → pages/toolchains/musl.md b/musl.md → pages/toolchains/musl.md
diff --git a/newlib.md → pages/toolchains/newlib.md b/newlib.md → pages/toolchains/newlib.md
diff --git a/toolchains.md → pages/toolchains/toolchains.md b/toolchains.md → pages/toolchains/toolchains.md
diff --git a/or1k-dev.tcl → resource/de0_nano/or1k-dev.tcl b/or1k-dev.tcl → resource/de0_nano/or1k-dev.tcl
diff --git a/sw/hello/hello.c → resource/de0_nano/sw/hello/hello.c b/sw/hello/hello.c → resource/de0_nano/sw/hello/hello.c
diff --git a/sw/timer/timer.c → resource/de0_nano/sw/timer/timer.c b/sw/timer/timer.c → resource/de0_nano/sw/timer/timer.c
diff --git a/platform/resources/hello-initramfs-host.png → resource/images/hello-initramfs-host.png b/platform/resources/hello-initramfs-host.png → resource/images/hello-initramfs-host.png
diff --git a/platform/resources/hello-initramfs-qemu.png → resource/images/hello-initramfs-qemu.png b/platform/resources/hello-initramfs-qemu.png → resource/images/hello-initramfs-qemu.png
diff --git a/platform/resources/qemu-bootup-output.png → resource/images/qemu-bootup-output.png b/platform/resources/qemu-bootup-output.png → resource/images/qemu-bootup-output.png
diff --git a/de0_nano/doc/uart.png → resource/images/uart.png b/de0_nano/doc/uart.png → resource/images/uart.png
diff --git a/or1ksim/Makefile → resource/or1ksim/Makefile b/or1ksim/Makefile → resource/or1ksim/Makefile
diff --git a/or1ksim/or1ksim.cfg → resource/or1ksim/or1ksim.cfg b/or1ksim/or1ksim.cfg → resource/or1ksim/or1ksim.cfg
diff --git a/platform/hello.c → resource/platform/hello.c b/platform/hello.c → resource/platform/hello.c