Skip to content

Commit f2554c7

Browse files
amilcarlucasamilcarlucas
committed
feat(gurubase): Integrate gurubase on more webpages
1 parent 3305931 commit f2554c7

9 files changed

+69
-8
lines changed

‎.markdownlint.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ MD033:
2121
- "figure"
2222
- "img"
2323
- "ins"
24+
- "script"
2425
- "table"
2526
- "td"
2627
- "th"

‎ARCHITECTURE.md

+13
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ the following system design requirements were derived:
8888
- The software must provide tooltips for each GUI widget.
8989
- The software must provide tooltips for each parameter to explain their purpose and usage.
9090
- Users should be able to access the blog post and other resources for more information on the software and its usage.
91+
- The software website should use an AI assistant, trained with ArduPilot documentation, to help users configure their
92+
vehicles [PR #175](https://github.com/ArduPilot/MethodicConfigurator/pull/175)
93+
- The AI assistant should be able to answer questions about the parameters and the configuration process
94+
- The AI assistant should be able to provide guidance on how to resolve common issues that may arise during the configuration process
9195

9296
#### 5. Error Handling and Logging
9397

@@ -532,3 +536,12 @@ foreach ($script in $scripts) {
532536
}
533537
}
534538
```
539+
540+
<!-- Gurubase Widget -->
541+
<script async src="https://widget.gurubase.io/widget.latest.min.js"
542+
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
543+
data-text="Ask AI"
544+
data-margins='{"bottom": "1rem", "right": "1rem"}'
545+
data-light-mode="true"
546+
id="guru-widget-id">
547+
</script>

‎INSTALL.md

+9
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,12 @@ Follow the linux installation instructions above.
9797
![Install ArduPilot firmware](images/MissionPlanne_install_firmware.png)
9898
1. Wait until the firmware download is complete.
9999
1. Disconnect the USB cable from the flight controller.
100+
101+
<!-- Gurubase Widget -->
102+
<script async src="https://widget.gurubase.io/widget.latest.min.js"
103+
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
104+
data-text="Ask AI"
105+
data-margins='{"bottom": "1rem", "right": "1rem"}'
106+
data-light-mode="true"
107+
id="guru-widget-id">
108+
</script>

‎README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,6 @@ SPDX-FileCopyrightText: 2024-2025 Amilcar do Carmo Lucas <[email protected]>
66
SPDX-License-Identifier: GPL-3.0-or-later
77
-->
88

9-
<!-- Gurubase Widget -->
10-
<script async src="https://widget.gurubase.io/widget.latest.min.js"
11-
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
12-
data-text="Ask AI"
13-
data-margins='{"bottom": "1rem", "right": "1rem"}'
14-
data-light-mode="true"
15-
id="guru-widget-id">
16-
</script>
179

1810
| Lint | Quality | Test | Deploy | Maintain |
1911
| ---- | ------- | ---- | ------ | -------- |
@@ -299,3 +291,12 @@ This project is licensed under the [GNU General Public License v3.0](https://git
299291
## Credits
300292

301293
It builds upon other [open-source software packages](https://ardupilot.github.io/MethodicConfigurator/credits/CREDITS.html)
294+
295+
<!-- Gurubase Widget -->
296+
<script async src="https://widget.gurubase.io/widget.latest.min.js"
297+
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
298+
data-text="Ask AI"
299+
data-margins='{"bottom": "1rem", "right": "1rem"}'
300+
data-light-mode="true"
301+
id="guru-widget-id">
302+
</script>

‎SUPPORT.md

+9
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,12 @@ Send a [private message to amilcarlucas at ardupilot support forum](https://disc
3131
and pricing of paid support services.
3232
Please include a brief description of your project and the kind of support you need.
3333
Please note that paid support is not a guarantee of success, but it will be prioritized over free support.
34+
35+
<!-- Gurubase Widget -->
36+
<script async src="https://widget.gurubase.io/widget.latest.min.js"
37+
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
38+
data-text="Ask AI"
39+
data-margins='{"bottom": "1rem", "right": "1rem"}'
40+
data-light-mode="true"
41+
id="guru-widget-id">
42+
</script>

‎TUNING_GUIDE_ArduCopter.md

+9
Original file line numberDiff line numberDiff line change
@@ -1199,3 +1199,12 @@ Enjoy,
11991199
Jan Ole Noack
12001200

12011201
Amilcar do Carmo Lucas
1202+
1203+
<!-- Gurubase Widget -->
1204+
<script async src="https://widget.gurubase.io/widget.latest.min.js"
1205+
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
1206+
data-text="Ask AI"
1207+
data-margins='{"bottom": "1rem", "right": "1rem"}'
1208+
data-light-mode="true"
1209+
id="guru-widget-id">
1210+
</script>

‎USECASES.md

+9
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,12 @@ Correct those entries and press the `Save data and start configuration` button a
164164
1. Follow the procedure to [configure the vehicle parameters](README.md#6-configure-the-vehicles-parameters-in-a-traceable-way)
165165

166166
If something is not clear, read the [ArduPilot Methodic Configurator user manual](USERMANUAL.md)
167+
168+
<!-- Gurubase Widget -->
169+
<script async src="https://widget.gurubase.io/widget.latest.min.js"
170+
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
171+
data-text="Ask AI"
172+
data-margins='{"bottom": "1rem", "right": "1rem"}'
173+
data-light-mode="true"
174+
id="guru-widget-id">
175+
</script>

‎USERMANUAL.md

+9
Original file line numberDiff line numberDiff line change
@@ -366,3 +366,12 @@ This will show a list of all available command line options along with a brief d
366366
If you encounter any issues during the configuration process, refer to the error messages provided by the application.
367367
These messages can guide you to the specific problem and suggest possible solutions.
368368
If the issue persists, consult the [documentation and support page](https://ardupilot.github.io/MethodicConfigurator/SUPPORT.html)
369+
370+
<!-- Gurubase Widget -->
371+
<script async src="https://widget.gurubase.io/widget.latest.min.js"
372+
data-widget-id="uE4kxEE4LY3ZSyfNsF5bU6gIOnWGTBOL_e16KwDH-0g"
373+
data-text="Ask AI"
374+
data-margins='{"bottom": "1rem", "right": "1rem"}'
375+
data-light-mode="true"
376+
id="guru-widget-id">
377+
</script>

‎credits/CREDITS.md

+1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Credits also go to these other software projects that helped in developing ArduP
7575
- [bestpractices.dev](https://www.bestpractices.dev/en): A site for checking best practices in software development.
7676
- [isitmaintained.com](https://isitmaintained.com/): A service to check the maintenance status of open-source projects.
7777
- [renovate](https://github.com/renovatebot/renovate): Cross-platform Dependency Automation by Mend.io
78+
- [gurubase](https://github.com/Gurubase/gurubase): An open-source RAG system that we used to create an AI-powered Q&A assistant.
7879

7980
Using these softwares allowed a small group of programmers to produce better code faster.
8081

0 commit comments

Comments
 (0)