Skip to content

Commit

Permalink
Add links to the homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
realcharmer committed Jun 17, 2024
1 parent c772277 commit 024b73a
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,33 @@ Welcome to the Capyboard documentation.
This is a documentation written for the [Capyboard devkit](https://github.com/realcharmer/capyboard) as a part of my master's thesis. Capyboard is a development board based on ESP32 and created specifically as an educational tool for gymnasiums and secondary schools. It can, however, be used in a wide range of real-world applications, just like any other ESP32 development kit.

Capyboard and all its assets are fully open-source, including the board and module schematics.

## Where to Start

<div class="grid cards" markdown>

- :material-cog: Getting Stared with Capyboard

---

Learn how to install and setup everything you need.

[:material-arrow-right: Getting Started](getting-started/installation.md)

- :material-chip: Modules & Technical Info

---

Technical information about each module, including pinouts, sensors used, and more.

[:material-arrow-right: Modules](modules/mainboard.md)

- :material-code-braces: Examples & Projects

---

Examples of educational and learning activities you can do with Capyboard.

[:material-arrow-right: Projects](projects/index.md)

</div>
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ markdown_extensions:
- pymdownx.superfences
- footnotes
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

0 comments on commit 024b73a

Please sign in to comment.