Skip to content

Commit 58b47b0

Browse files
ralph-langeralph-lange
committed
Introduced more menus while keeping one docs folder.
Signed-off-by: Ralph Lange (CR/AEE1) <ralph.lange@de.bosch.com>
1 parent d4b99f2 commit 58b47b0

30 files changed

Lines changed: 41 additions & 50 deletions

‎.vscode/settings.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"spellright.language": [],
3+
"spellright.documentTypes": [
4+
"latex",
5+
"plaintext"
6+
]
7+
}

‎_data/docs.yml‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
- title: General
1+
- title: Overview
22
docs:
3-
- home
4-
- hardware_support
3+
- overview
4+
- overview/hardware
5+
- overview/comparison
56

6-
# placeholder for tutorials...
7-
- title: Basic Tutorials
7+
- title: Tutorials - Basic
88
docs:
9-
- tutorials
109
- tutorials/getting_started
1110
- tutorials/getting_started_embedded
1211
- tutorials/getting_started_simulator
13-
14-
- title: Advanced Tutorials
12+
13+
- title: Tutorials - Advanced
1514
docs:
1615
- tutorials/advanced/nuttx_getting_started
1716
- tutorials/advanced/debugging-gdb-openocd
@@ -20,9 +19,9 @@
2019

2120
- title: Concepts
2221
docs:
23-
- rtos
24-
- client_library
25-
- real-time_executor
26-
- system_modes
27-
- embedded_tf
28-
- FIROS2
22+
- concepts/rtos
23+
- concepts/client_library
24+
- concepts/real-time_executor
25+
- concepts/system_modes
26+
- concepts/embedded_tf
27+
- concepts/FIROS2

‎_docs/architecture.md‎

Whitespace-only changes.

_docs/FIROS2/index.md renamed to _docs/concepts/FIROS2/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: micro-ROS & FIWARE
3-
permalink: /docs/FIROS2/
3+
permalink: /docs/concepts/FIROS2/
44
redirect_from: /FIROS2/
55
---
66

_docs/client_library/decision_paper/allocations_Fast-RTPS.png renamed to _docs/concepts/client_library/decision_paper/allocations_Fast-RTPS.png

File renamed without changes.

_docs/client_library/decision_paper/allocations_Micro_XRCE-DDS.png renamed to _docs/concepts/client_library/decision_paper/allocations_Micro_XRCE-DDS.png

File renamed without changes.

_docs/client_library/decision_paper/index.md renamed to _docs/concepts/client_library/decision_paper/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Client Library - Decision Paper
3-
permalink: /docs/client_library/decision_paper/
3+
permalink: /docs/concepts/client_library/decision_paper/
44
---
55

66
This document shall serve as decision template for the design and implementation of the micro-ROS client library. We discuss different options and existing starting points for this undertaking, decision criteria and analysis results regarding the existing assets.
@@ -104,7 +104,7 @@ With the Micro XRCE-DDS middleware, we obtained the following numbers:
104104
![Allocations with Micro XRCE-DDS](allocations_Micro_XRCE-DDS.png)
105105

106106
For curiosity, the numbers for Fast-RTPS:
107-
107+
108108
![Allocations with Fast-RTPS](allocations_Fast-RTPS.png)
109109

110110
### Current work on ROS 2
@@ -214,4 +214,4 @@ Diagnostics (Bosch)
214214

215215
Power management (Acutronic Robotics)
216216

217-
* Highly dependent on RTOS, it would require implementation for each one
217+
* Highly dependent on RTOS, it would require implementation for each one

_docs/client_library/index.md renamed to _docs/concepts/client_library/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Client Library
3-
permalink: /docs/client_library/
3+
permalink: /docs/concepts/client_library/
44
---
55

66
## Overview
@@ -15,4 +15,4 @@ Advanced concepts developed in the context of the client library are documented
1515

1616
* [Real-Time Executor](/docs/real-time_executor/)
1717
* [System Modes](/docs/system_modes/)
18-
* [Embedded Transform (TF)](/docs/embedded_tf/)
18+
* [Embedded Transform (TF)](/docs/embedded_tf/)

_docs/embedded_tf/index.md renamed to _docs/concepts/embedded_tf/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Embedded Transform (TF)
3+
permalink: /docs/concepts/embedded_tf/
34
redirect_from: /embedded_tf/
4-
permalink: /docs/embedded_tf/
55
---
66

77
Table of contents

_docs/real-time_executor/cbg-executor_sample_system.png renamed to _docs/concepts/real-time_executor/cbg-executor_sample_system.png

File renamed without changes.

0 commit comments

Comments
 (0)