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

chore(docs): restore original image paths but change baseurl _config.yml configuration #22

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
0c1fe8b
fix(basic-sample): update include to resolve deprecation warning
maarten1C96 Apr 2, 2024
e1d8705
feat(docs/zephyr-setup/macos): add note for navigation shortcut to ba…
maarten1C96 Apr 2, 2024
450eba7
docs(zephyr-structure.md): Adjust relative path for image in zephyr-s…
maarten1C96 Apr 3, 2024
e816c2e
chore(.gitignore): update ignored files and directories
maarten1C96 Apr 3, 2024
fb29665
docs(zephyr-structure.md): Adjust relative path for images in zephyr-…
maarten1C96 Apr 3, 2024
097b0b3
fix(docs): Update all image paths in project documentation
maarten1C96 Apr 6, 2024
7b85d41
Merge branch 'maksimdrachov:main' into main
maarten1C96 Apr 6, 2024
ec5b669
chore(.gitignore): improve ignoring of .DS_Store files globally
maarten1C96 Apr 7, 2024
e69fc40
chore(.gitignore): improve ignoring of .DS_Store files globally
maarten1C96 Apr 7, 2024
c08f62a
Merge branch 'main' of https://github.com/maarten1C96/zephyr-rtos-tut…
maarten1C96 Apr 7, 2024
8309c79
chore(docs): standardise image paths for both GitHub and Jekyll compa…
maarten1C96 Apr 7, 2024
a8ddd10
chore(docs): restore original images paths but keep _config.yml confi…
maarten1C96 Apr 7, 2024
232e309
chore(docs): restore original image paths but keep _config.yml config…
maarten1C96 Apr 7, 2024
e3ff391
Merge branch 'main' of https://github.com/maarten1C96/zephyr-rtos-tut…
maarten1C96 Apr 7, 2024
4e46605
chore(incomplete.md): copy incomplete.md to docs directory as simple …
maarten1C96 Apr 7, 2024
675ff22
chore(_config.yml): comment out baseurl specification in Jekyll confi…
maarten1C96 Apr 7, 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
Binary file removed .DS_Store
Binary file not shown.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,8 @@ tags

_site
.jekyll-cache
vendor
vendor

**/.DS_Store
.vscode/
.history/
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
title: Zephyr Tutorial
remote_theme: bedroesb/just-the-docs

# baseurl: "/zephyr-rtos-tutorial"

plugins:
- jekyll-relative-links
- jekyll-remote-theme
Expand Down
Binary file removed docs/.DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/1-zephyr-setup/install/mac-os.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,5 @@ A successful flash looks like this:

{: .warning}
> Some boards will require installing an additional `pyocd` package!
> ![pyocd-error](../../../images/zephyr-setup/pyocd-error.png)
> ![pyocd-error](/../images/zephyr-setup/pyocd-error.png)
> For Nucleo L552ZE-Q: `pyocd pack install stm32l552zetxq` (see [pyocd/target_support](https://pyocd.io/docs/target_support.html#managed-packs))
1 change: 1 addition & 0 deletions docs/1-zephyr-setup/setup/mac-os.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ west flash

{: .note }
> If you've previously made a build for a different board, remove the old build first: `rm -rf build`
> For convenience, full path to the basic-sample page: `cd ~/zephyrproject/zephyr-rtos-tutorial/exercises/basic-sample`

- Verify the serial output:

Expand Down
2 changes: 1 addition & 1 deletion docs/2-introduction/rtos-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Each **thread** (or task) will use registers and memory as it executes. The whol

Along with threads, you'll be using primitives such as **queues**, **mutexes** and **semaphores** for inter-thread communication. Then each RTOS provides varying levels of support for different protocols such as **TCP/IP**, **Bluetooth**, **LoRaWan**,... This makes your life easier, since now you don't need to study these protocols as in-depth. You'll get a series of API calls which should increase speed of development.

![rtos-basic-execution](../../images/2-introduction/rtos_basic_execution.gif)
![rtos-basic-execution](/images/2-introduction/rtos_basic_execution.gif)
2 changes: 2 additions & 0 deletions docs/_includes/incomplete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{: .warning}
This section is incomplete. You can help by [contributing](https://github.com/maksimdrachov/zephyr-rtos-tutorial).
2 changes: 1 addition & 1 deletion exercises/basic-sample/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* SPDX-License-Identifier: Apache-2.0
*/

#include <zephyr/zephyr.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/devicetree.h>

Expand Down
Binary file removed images/.DS_Store
Binary file not shown.