From ec427ebda8c1fbdf3e628a05ded6ef8519b7b911 Mon Sep 17 00:00:00 2001 From: Marno van der Maas Date: Tue, 11 Jun 2024 16:48:01 +0100 Subject: [PATCH 1/2] Using sentence case consistently in summary --- SUMMARY.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 5dba5bdc4..ed9447e41 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,13 +4,13 @@ - [Getting started](doc/guide/getting-started.md) - [Reloading the RP2040](doc/guide/rp2040-update.md) - - [Reloading the FPGA Image](doc/guide/fpga-update.md) - - [Building Examples](doc/guide/building-examples.md) + - [Reloading the FPGA image](doc/guide/fpga-update.md) + - [Building examples](doc/guide/building-examples.md) -- [Developer Guide](doc/dev/developing.md) - - [Programming Sonata Software](doc/dev/sw-programming.md) - - [Software Toolchain Setup](doc/dev/toolchain-setup.md) - - [Reference Manual for Sonata Core](doc/dev/ref-manual.md) +- [Developer guide](doc/dev/developing.md) + - [Programming sonata software](doc/dev/sw-programming.md) + - [Software toolchain setup](doc/dev/toolchain-setup.md) + - [Reference manual for sonata core](doc/dev/ref-manual.md) - [Ibex](doc/ip/ibex.md) - [Debug module](doc/ip/dm.md) - [GPIO](doc/ip/gpio.md) @@ -22,10 +22,10 @@ - [HyperRAM](doc/ip/ram.md) - [PWM](doc/ip/pwm.md) - [PLIC](doc/ip/plic.md) - - [FPGA Development](doc/dev/fpga-development.md) - - [FPGA Programming](doc/dev/fpga-programming.md) - - [Simulation Environment](doc/dev/simulation.md) - - [Building Documentation](doc/dev/building-doc.md) + - [FPGA development](doc/dev/fpga-development.md) + - [FPGA programming](doc/dev/fpga-programming.md) + - [Simulation environment](doc/dev/simulation.md) + - [Building documentation](doc/dev/building-doc.md) -- [Sonata Board](doc/architecture/board.md) +- [Sonata board](doc/architecture/board.md) From 6fdad251f4df298b9ca8fd5b538a0c33c83192e1 Mon Sep 17 00:00:00 2001 From: Marno van der Maas Date: Tue, 11 Jun 2024 16:48:48 +0100 Subject: [PATCH 2/2] Add repo and edit links to mdbook --- book.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/book.toml b/book.toml index af6e21bc0..d19e16c93 100644 --- a/book.toml +++ b/book.toml @@ -5,6 +5,9 @@ src = "." title = "Sonata System Documentation" [output.html] +git-repository-url = "https://github.com/lowRISC/sonata-system" +edit-url-template = "https://github.com/lowRISC/sonata-system/edit/main/{path}" + additional-js = [ "./util/mdbook/wavejson/default.js", "./util/mdbook/wavejson/wavedrom.min.js",