Skip to content

Commit 5735fc7

Browse files
committed
refactor some stuff, add writings
The goal is to show the sites capabilities to be a knowledge base for the entire lab.
1 parent 5084a2a commit 5735fc7

12 files changed

Lines changed: 719 additions & 45 deletions

README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
This guide is written in **Markdown**. To add a new page:
3+
4+
1. Create a new `.md` file in the `docs/guide/` directory.
5+
2. Add the link to `docs/.vitepress/config.mts` under the `sidebar` section.

docs/.vitepress/config.mts

Lines changed: 48 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,61 @@ export default defineConfig({
99
// https://vitepress.dev/reference/default-theme-config
1010
nav: [
1111
{ text: 'Home', link: '/' },
12-
{ text: 'Guide', link: '/guide/getting-started' }
12+
{ text: 'Guide', link: '/guide/getting-started' },
13+
{ text: 'IIR', link: '/iir/iir-quick-start' },
14+
{ text: 'MRUH', link: '/mruh/index' },
15+
{ text: 'Reference', link: '/reference/glossary' }
1316
],
1417

15-
sidebar: [
16-
{
17-
text: 'Introduction',
18-
items: [
19-
{ text: 'Getting Started', link: '/guide/getting-started' },
20-
{ text: 'Installation', link: '/guide/installation' },
21-
22-
]
23-
},
24-
{
25-
text: 'Core Concepts',
26-
items: [
27-
// Add more sections here as you write them
28-
]
29-
},
30-
{
31-
text: 'Reference',
32-
items: [
33-
{ text: 'Glossary', link: '/guide/glossary' }
34-
]
35-
}
36-
],
18+
sidebar: {
19+
'/guide/': [
20+
{
21+
text: 'Guide',
22+
items: [
23+
{ text: 'Getting Started', link: '/guide/getting-started' },
24+
{ text: 'Installation', link: '/guide/installation' },
25+
{ text: 'ROS2 Use Cases and Structure', link: '/guide/ros2-use-cases-and-structure' },
26+
{ text: 'ROS2 Links', link: '/guide/ros2-links' }
27+
]
28+
}
29+
],
30+
'/iir/': [
31+
{
32+
text: 'Infrastructure Inspection Robot',
33+
items: [
34+
{ text: 'Quick Start', link: '/iir/iir-quick-start' },
35+
{ text: 'Operation Guide', link: '/iir/iir-operation-guide' },
36+
{ text: 'Architecture Documentation', link: '/iir/Infrastructure Inspection Robot (IIR) Architecture Documentation' }
37+
]
38+
}
39+
],
40+
'/reference/': [
41+
{
42+
text: 'Reference',
43+
items: [
44+
{ text: 'Glossary', link: '/reference/glossary' },
45+
{ text: 'NetworkManager CLI nmcli', link: '/reference/NetworkManager CLI nmcli' },
46+
{ text: 'Tailscale ACL Configuration', link: '/reference/Tailscale ACL Configuration' }
47+
]
48+
}
49+
],
50+
'/mruh/': [
51+
{
52+
text: 'MRUH',
53+
items: [
54+
{ text: 'Index', link: '/mruh/index' }
55+
]
56+
}
57+
]
58+
},
3759

3860
socialLinks: [
39-
// { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
61+
{ icon: 'github', link: 'https://github.com/riplaboratoryuh' }
4062
],
4163

4264
footer: {
43-
message: 'Released under the MIT License.',
44-
copyright: 'Copyright © 2024'
65+
message: '',
66+
copyright: 'Copyright © 2026'
4567
}
4668
}
4769
})

docs/guide/getting-started.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,13 @@ When I first started, I had no idea where to look for more information on certai
66

77
Alternatively, if you are a mechanical engineer, and just trying to understand the basics of ROS2, this document will still be helpful, but all of the links may not pertain to you. Check out the Quick Start page for the bare minimum information.
88

9-
## What is ROS2?
9+
## How to Use This Guide
1010

11-
ROS2 (Robot Operating System 2) is an open-source set of software libraries and tools that help you build robot applications.
11+
Take your time absorbing everything. There will be a lot of information here, so feel free to take breaks, come back to difficult topics, or check out the [Glossary] page to find definitions of words.
1212

13-
## How to use this guide
13+
Due to the open-source aspect of ROS2, most of the important information about developing and using it already exists and is free to access!
1414

15-
This guide is written in **Markdown**. To add a new page:
15+
The information present in this guide will generally be presented in the form of links to other sites. Links presented *like so* are vital curriculum! There may be other links that are extraneous or are good to know but not essential. These will be presented **like so**.
1616

17-
1. Create a new `.md` file in the `docs/guide/` directory.
18-
2. Add the link to `docs/.vitepress/config.mts` under the `sidebar` section.
1917

20-
### Code Example
2118

22-
```bash
23-
# Example command
24-
ros2 run demo_nodes_cpp talker
25-
```
26-
27-
::: tip
28-
This is a tip box. You can use it to highlight important information.
29-
:::
30-
31-
::: warning
32-
This is a warning box. Use it for critical alerts.
33-
:::

docs/guide/ros2-links.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ROS2 Quick Reference
2+
3+
## ROS2 Docs
4+
5+
6+
7+
8+
9+
## Tutorials
10+
11+
https://articulatedrobotics.xyz/category/coordinate-transforms-for-robotics
12+
13+
https://www.youtube.com/watch?v=2lIV3dRvHmQ – AR 5 things to start ROS2
14+

docs/guide/ros2-use-cases-and-structure.md

Whitespace-only changes.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## System Architecture
2+
3+
[Diagram or description of how components interact]
4+
5+
### Components
6+
7+
- ROS2 Nodes
8+
- URDF
9+
- Robot State Publisher
10+
- Joint State Publisher
11+
- Ros2 Control
12+
-
13+
- RPI Periphery
14+
- Camera
15+
- CAN-Bus Adapter
16+
- Fans
17+
- ODrive

0 commit comments

Comments
 (0)