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

WIP - Documentation website #1

Closed
wants to merge 42 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
5170e44
Test github pages build & deployment
klaasnicolaas Jan 26, 2024
f41b521
Remove template files from scaffold
klaasnicolaas Jan 26, 2024
0059956
Add introduction page
klaasnicolaas Jan 26, 2024
5ef94e4
Add FAQ section
klaasnicolaas Jan 26, 2024
6f9f1c5
Make styling changes and update sidebar
klaasnicolaas Jan 26, 2024
12a316a
Fix build issue with wrong link
klaasnicolaas Jan 26, 2024
b3a4db2
Steps draft on the installation instructions
klaasnicolaas Jan 26, 2024
aa87dd8
Add ESP Web tools button with instructions
klaasnicolaas Jan 27, 2024
708cff8
Test building the firmware and artifact upload
klaasnicolaas Jan 27, 2024
400a4c0
Test again
klaasnicolaas Jan 27, 2024
ab2b124
Test again
klaasnicolaas Jan 27, 2024
59dd67d
Use pattern not name for download artifact
klaasnicolaas Jan 27, 2024
a898965
Test again
klaasnicolaas Jan 27, 2024
632e451
Test again
klaasnicolaas Jan 27, 2024
f18a146
Test again
klaasnicolaas Jan 27, 2024
081dd53
Test again with docs build added
klaasnicolaas Jan 27, 2024
e6afd73
Test with building de static docusaurus website
klaasnicolaas Jan 27, 2024
2ebc8bf
Test again
klaasnicolaas Jan 27, 2024
2a64d59
Test again
klaasnicolaas Jan 27, 2024
dc26e24
Add deployment to github pages
klaasnicolaas Jan 27, 2024
781dbfa
Add note when you forgot the BOOT button
klaasnicolaas Jan 27, 2024
9b9e2c3
Fix 404 error for wrong path to firmware bin
klaasnicolaas Jan 27, 2024
87d3b2e
Update the install instructions
klaasnicolaas Jan 27, 2024
443842d
Update the firmware install instructions
klaasnicolaas Jan 27, 2024
e18dcfe
Write out step 2 and 3 of the installation instruction
klaasnicolaas Jan 27, 2024
f8d86fa
Add instructions for firmware customization
klaasnicolaas Jan 27, 2024
4dae5f2
Small textual changes on the docs
klaasnicolaas Jan 27, 2024
31a26ed
Add last page update date to every docs page
klaasnicolaas Jan 27, 2024
af2dad1
Add local search
klaasnicolaas Jan 27, 2024
e8d1115
Update meta data
klaasnicolaas Jan 27, 2024
a530aa3
Use other color scheme
klaasnicolaas Jan 28, 2024
34a5620
Add icon for Github in navbar
klaasnicolaas Jan 28, 2024
c9d0966
Add configuration for renaming device
klaasnicolaas Jan 28, 2024
3c89ec2
Add github as icon in the navbar
klaasnicolaas Jan 28, 2024
b28d1e4
Debug building matrix and gently stop the CI
klaasnicolaas Jan 28, 2024
2dd120f
Test again
klaasnicolaas Jan 28, 2024
05aeae5
Test again
klaasnicolaas Jan 28, 2024
0619a51
Test again
klaasnicolaas Jan 28, 2024
36bbb78
Test again
klaasnicolaas Jan 28, 2024
78d9224
Update the first time install instructions
klaasnicolaas Jan 28, 2024
417026e
Change instruction for step 6 and 7
klaasnicolaas Feb 5, 2024
e808218
Small textual change
klaasnicolaas Feb 12, 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
Prev Previous commit
Next Next commit
Update the first time install instructions
klaasnicolaas committed Jan 28, 2024
commit 78d9224de9f6e921f9187d8315fba1a7cbda497d
24 changes: 15 additions & 9 deletions docs/docs/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -23,16 +23,22 @@ Use the method below to provide your Onju Voice PCB with the correct firmware.
_Make sure this page is opened in a Chromium-based browser on a desktop. The software installation does not work with a tablet or phone._

1. Press the blue **connect** button below, a pop-up window will appear with a list of available USB devices.
2. Plug the USB cable into the Onju Voice PCB and connect it to your computer.
3. In the pop-up window, there should now appear a new entry. Select this USB serial port and click **Connect**.
4. Select **Install Onju Voice Satellite**, hold down the `BOOT` button on the Onju Voice PCB and click **Install**.
5. Once the installation is complete, select **Next**.
2. Hold down the `BOOT` button on the Onju Voice PCB ans connect a USB cable.
- _Note_: this prevents the device from reconnecting repeatedly.
3. In the pop-up window, a new entry should appear. Select this USB serial port and click **Connect**.
4. Choose **Install Onju Voice Satellite**, then click **Install**.
5. After installation, select **Next**.
- _Note_: since the device is still in BOOT mode, you'll return to a previous pop-up window.
6. Press the `RST` button on the Onju Voice PCB to reboot the device.
7. Refresh the browser page, and repeat steps 1 and 3 to reconnect to the device.
8. In the pop-up window, choose **Connect to Wi-Fi**.
- Add the Onju Voice Satellite to your Wi-Fi network:
- When prompted, select your network from the list and enter the credentials to your 2.4 GHz Wi-Fi network.
- Select **Connect**.
- The Onju Voice Satellite now joined your network.
6. Congratulations 🎉 You have successfully installed the firmware on your Onju Voice Satellite.
- The LED's on the Onju Voice PCB should now be blinking green.
- Select your network from the list and enter the credentials for your 2.4 GHz Wi-Fi network.
- Click **Connect**.
- The Onju Voice Satellite is now connected to your network.
- _note_: If you wait to long, the option to connect to Wi-Fi disappears. In that case, repeat step 6 - 8.
9. Congratulations 🎉 You have successfully installed the firmware on your Onju Voice Satellite.
- The LEDs on the Onju Voice PCB should now be blinking green.

:::note
If your device does not appear in the list, make sure you are using a USB data cable (i.e., not power-only), and try installing the [driver](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads) for the serial chip.