Skip to content

Commit

Permalink
Add new guide manual
Browse files Browse the repository at this point in the history
  • Loading branch information
JakubAndrysek committed Sep 20, 2023
1 parent 27db166 commit a91b8f1
Show file tree
Hide file tree
Showing 15 changed files with 93 additions and 13 deletions.
13 changes: 9 additions & 4 deletions .github/workflows/deploy-web.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
name: Build and deploy docs to GitHub Pages
name: Deploy to GitHub Pages
on:
push:
branches:
- master
- main
# schedule:
# - cron: '0 0 1 * *' # every month
permissions:
contents: write
jobs:
Expand All @@ -14,10 +16,13 @@ jobs:
- uses: actions/setup-python@v4
with:
python-version: 3.x
- uses: actions/cache@v2
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: ${{ github.ref }}
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install -r requirements.txt
- run: make fixRelativeLinkDocs
- run: mkdocs gh-deploy --force
- run: mkdocs gh-deploy --force
2 changes: 1 addition & 1 deletion README.cs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Pájecí challenge je skvělý způsob jak se naučit pájet SMD součástky.

<div align="center">
<img src="./docs/media/solderingChallenge.png">
<img src="./docs/media/solderingChallenge-2.png">
</div>

Pájecí výzva spočívá v zapájení všech součástek na DPS v co nejkratším čase.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Solving the SMD soldering challenge is a great way to learn how to solder SMD components.

<div align="center">
<img src="./docs/media/solderingChallenge.png">
<img src="./docs/media/solderingChallenge-2.png">
</div>

The challenge is to solder all the components on the PCB in the shortest time possible.
Expand Down
2 changes: 1 addition & 1 deletion docs/README.cs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Pájecí challenge je skvělý způsob jak se naučit pájet SMD součástky.

<div align="center">
<img src="./media/solderingChallenge.png">
<img src="./media/solderingChallenge-2.png">
</div>

Pájecí výzva spočívá v zapájení všech součástek na DPS v co nejkratším čase.
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Solving the SMD soldering challenge is a great way to learn how to solder SMD components.

<div align="center">
<img src="./media/solderingChallenge.png">
<img src="./media/solderingChallenge-2.png">
</div>

The challenge is to solder all the components on the PCB in the shortest time possible.
Expand Down
37 changes: 37 additions & 0 deletions docs/assembly.cs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Osazovací návod

## Jak postupovat

- **Vždy pájej pouze jednu úroveň najednou.**
- Vždy si vezmi jednu součástku, tu zapájej a až pak pokračuj s další.
- Začni připájením integrovaného obvodu.
U integrovaného obvodu si pohlídej jeho orientaci. Pokud si nejsi jistý, zeptej se lektora.
- Pak můžeš zapájet ostatní součástky.
- Jakmile máš zapájeno, nalep zespodu USB konektoru podložku.

!!! danger "Bezpečnost práce"
- Hrot páječky je horký (~300 °C).
- Páječku vždy odkládejte do stojanu.
- Udržujte pořádek na pracovišti.


# L1 - THT

![](/media/solderingChallenge-L1.png){: style="width:300px"}

??? info "LED"
U LED běžně na polaritě záleží. Na této desce však polaritu řešit nemusíte, obvod je navržen tak, aby na polaritě nezáleželo.

# L2 - 1206
![](/media/solderingChallenge-L2.png){: style="width:300px"}

??? info "LED"
U LED běžně na polaritě záleží. Na této desce však polaritu řešit nemusíte, obvod je navržen tak, aby na polaritě nezáleželo.


# L3 - 0603
![](/media/solderingChallenge-L3.png){: style="width:300px"}

??? info "LED"
U LED běžně na polaritě záleží. Na této desce však polaritu řešit nemusíte, obvod je navržen tak, aby na polaritě nezáleželo.

34 changes: 34 additions & 0 deletions docs/assembly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Soldering Instructions

## How to Proceed

- **Always solder only one level at a time.**
- Always take one component, solder it, and then proceed with the next.
- Start by soldering the integrated circuit.
- Be mindful of the orientation of the integrated circuit. If you're unsure, ask the instructor.
- Then you can solder the other components.
- Once you have soldered, attach a pad underneath the USB connector.

!!! danger "Work Safety"
- The tip of the soldering iron is hot (~300 °C).
- Always place the soldering iron back in its stand.
- Keep your workspace tidy.

# L1 - THT

![](/media/solderingChallenge-L1.png){: style="width:300px"}

??? info "LED"
- Polarity usually matters with LEDs. However, on this board, you don't have to worry about polarity; the circuit is designed to be polarity-independent.

# L2 - 1206
![](/media/solderingChallenge-L2.png){: style="width:300px"}

??? info "LED"
- Polarity usually matters with LEDs. However, on this board, you don't have to worry about polarity; the circuit is designed to be polarity-independent.

# L3 - 0603
![](/media/solderingChallenge-L3.png){: style="width:300px"}

??? info "LED"
- Polarity usually matters with LEDs. However, on this board, you don't have to worry about polarity; the circuit is designed to be polarity-independent.
Binary file added docs/media/solderingChallenge-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/solderingChallenge-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/solderingChallenge-L1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/solderingChallenge-L2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/solderingChallenge-L3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "https://raw.githubusercontent.com/RoboticsBrno/Our-team/main/team.html"
1 change: 1 addition & 0 deletions docs/team/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "https://raw.githubusercontent.com/RoboticsBrno/Our-team/main/team.html"
12 changes: 7 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,19 @@ plugins:
name: Czech (cs)
build: true
site_name: RB0011 Pájecí výzva
# nav_translations:
# fr:
# Topic1: Sujet1
# Topic2: Sujet2
- git-revision-date-localized


markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- attr_list
- admonition
- pymdownx.details
- pymdownx.snippets:
url_download: True

nav:
- Home: 'README.md'
- Home: 'README.md'
- assembly.md
- team.md

0 comments on commit a91b8f1

Please sign in to comment.