Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo link #123

Merged
merged 2 commits into from
Jun 12, 2024
Merged

Repo link #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec427eb
Using sentence case consistently in summary
marnovandermaas Jun 11, 2024
6fdad25
Add repo and edit links to mdbook
marnovandermaas Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the previous style. Is there a particular English style lowRISC follows?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm used to sentence case in academic writing because it makes it easier to read headings. Either way it was inconsistent.

- [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)
Expand All @@ -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)

3 changes: 3 additions & 0 deletions book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down