Skip to content

Commit 46710f8

Browse files
authored
Port to MkDocs and update BeagleY-AI guide (#1)
* Apply MkDocs template * Remove "viewed as webpage" note * Use admonition for wire peeling * Use main branch for Pages builds * Add link to original guide * Correct formatting and layout * Fix Home page formatting * Add mkdocs-material scheme * Enable emojis & icons * Enable keyboard styled * Add branding to site * Fix ordering of top nav items * Fix nav headers * Fix links in Beagle guide * Add prototype Q&A section * Add instruction to enable wlan0 * Add blurb about kernels * Reorder Beagle instructions * Move board-specific info to own directories * Fix cable section * Add link to getting started guide in computing doc * Update OS setup to use bb-imager * Use requirements.txt
1 parent e0e65fd commit 46710f8

File tree

100 files changed

+730
-393
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+730
-393
lines changed

.github/workflows/mkdocs_ghp.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions-material-for-mkdocs
2+
name: mkdocs_ghp
3+
on:
4+
push:
5+
branches:
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Configure Git Credentials
15+
run: |
16+
git config user.name github-actions[bot]
17+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: 3.x
21+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
22+
- uses: actions/cache@v4
23+
with:
24+
key: mkdocs-material-${{ env.cache_id }}
25+
path: .cache
26+
restore-keys: |
27+
mkdocs-material-
28+
- run: pip install pymdown-extensions
29+
- run: pip install mkdocs-material
30+
- run: pip install mkdocs-callouts
31+
- run: pip install mkdocs-pagetree-plugin
32+
- run: pip install mkdocs-material
33+
- run: pip install mkdocs-awesome-nav
34+
- run: mkdocs gh-deploy --force

README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

beagley-ai.md

Lines changed: 0 additions & 158 deletions
This file was deleted.

docs/.nav.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
nav:
2+
- Home: index.md
3+
- Power: power.md
4+
- Computing: computing.md
5+
- Tools: tools.md
6+
- Wiring: wiring.md
7+
- Parts: parts.md
8+
- Boards:
9+
- BeagleY-AI: boards/beagley-ai
10+
- Raspberry Pi: boards/raspberry-pi
11+
- TI TDA4VM: boards/tda4vm
12+
- Brand: brand.md
13+
- Archive: archive.md
File renamed without changes.
File renamed without changes.

apps.md renamed to docs/apps.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# Applications.md
2-
3-
[view as WEB PAGE](https://qr.page/g/15vgHvaHTAe ':class=button')
1+
# Applications
42

53
*This page is intended to serve the same function as the SCUTTLE [Applications Guide](https://www.scuttlerobot.org/resource/guide/applications-guide/) (in PDF) but to become more dynamic, open, and easily navigable.
64

@@ -11,9 +9,11 @@ Robotic projects, listed by their application, which focus a project on a mechan
119
## Example 1.17 Pole-mounted Maintenance
1210

1311
**Discussion of problem:**
12+
1413
* Tasks that require a broomstick are often tedious, located in narrow spaces, or requiring frequent repetition. The fact that we have attached an item to a broomstick indicates right away that the human arm is not sufficient to do a job easily.
1514

1615
**Discussion of solution:**
16+
1717
* Achieve painting, cleaning, or other maintenance functions with your SCUTTLE by attaching any off-the-shelf tool that uses the standard ACME (broomstick) thread.
1818

1919
**Why it's easy**
@@ -24,13 +24,15 @@ Here's a 3D Model you can print for threads, credit to FredSWUG on GrabCAD. [vi
2424
## Example 1.18 Ship Painter
2525

2626
**Discussion of problem:**
27+
2728
* The most expensive part of a ship is the maintenance, which relies on continuous painting to prevent corrosion
2829
* Every crew member of a ship is costly, so docking the ships may be required to dock for painting.
2930
* Discovery of rust & deteriorated paint may be more important than applying paint.
3031
* It is tedious to search a whole ship for rust so currently there is no affordable solution.
3132
* Remote communication is unreliable on the sea, so remote expertise cannot help very much with identifying rust, etc.
3233

3334
**Discussion of solution:**
35+
3436
* A robot painter could make continuous scanning for rust, 24 hours per day, reducing docking time for the ship.
3537
* The robot painter can utilize edge AI to take photos and evaluate paint
3638
* While automation is still expensive, only high-cost problems are feasible and this is a high-cost problem.
File renamed without changes.

0 commit comments

Comments
 (0)