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.

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

Migrating documentation to Github Pages #217

Merged
merged 15 commits into from
Apr 20, 2022
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: Robert Jördens <[email protected]>
ryan-summers and jordens authored Apr 20, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 6187e1bdce3376cf3c016ec4b867b3ff3eb70305
2 changes: 1 addition & 1 deletion book/src/firmware-update.md
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ The following instructions describe the process of uploading a new firmware imag
Bootloader USB interface.

1. Generate the firmware image: `cargo build`
- Note: You may append `--release` to build the firmware with more optimization and less debugging information.
- Note: For production usage, you should append `--release` to build the firmware with more optimization and slightly less debugging information.
- Note: You may also use the latest [pre-built](https://github.com/quartiq/booster/releases) assets instead of building firmware.

1. Generate the binary file for your firmware build: `cargo objcopy -- -O binary booster.bin`
2 changes: 1 addition & 1 deletion book/src/front-panel.md
Original file line number Diff line number Diff line change
@@ -55,7 +55,7 @@ In the example above, it can be seen that CH0 is enabled with RF power
amplification.

Channel 2 is enabled, but one of the interlocks has tripped, so no RF power amplification is
occurring. This channl interlock can be cleared by pressing the "Interlock Reset" button after the
occurring. This channel interlock can be cleared by pressing the "Interlock Reset" button after the
trip source has been removed.

Channels 1 and 3-7 are all powered up, but disabled, so there is no RF amplification.
2 changes: 1 addition & 1 deletion book/src/overview.md
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ been recovered the firmware will be offered under an open source license.
Booster is an 8 channel RF power amplifier in the Sinara open hardware ecosystem.
The open hardware designs and hardware discussions are located at
https://github.com/sinara-hw/Booster/wiki.
The hardware is available from Creotech, QUARTIQ, Technosyste, and M-Labs.
The hardware is available from Creotech, QUARTIQ, Technosystem, and M-Labs.

# Getting Started