Repository navigation
Expand file tree
/
Copy pathversions.yml
More file actions
98 lines (94 loc) · 3.64 KB
/
Copy pathversions.yml
File metadata and controls
98 lines (94 loc) · 3.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# The version facts of this documentation, in ONE place (versioning step V6, 2026-10-22).
#
# Edit them here, never in a page. hooks/versions.py writes them into every manual's version box
# (<!-- doc-meta: KEY --> on its landing page), into the list of documents (<!-- documents-table --> on every
# About page) and into the versions and links of the downloads (<!-- version: runtime -->, <!-- version-link: ... -->).
# tools/sync_runtime.py and the publishing workflow read it too. README.md, "Versions and releases",
# says when to change what.
# The documentation version: the runtime's MAJOR.MINOR these pages describe. The publishing workflow publishes the
# site under this name (the version selector in the header) and points "latest" at it.
docs_version: "1.1"
# The runtime release the generated pages come from (tools/sync_runtime.py): the compatibility table, the runtime
# release notes, the error and event codes, the telemetry tags. Its MAJOR.MINOR must be docs_version.
runtime:
repository: https://github.com/Source-Robotics/RCB-Runtime
tag: v1.1.1
# The operating system image of the control box's Raspberry Pi 5: the one the runtime release is tested on (the
# runtime's README, "OS image", and the OS image column of the compatibility table; tools/test_tools.py checks that
# the two agree). Its release page is where the image is downloaded.
os_image:
repository: https://github.com/ros-realtime/ros-realtime-rpi4-image
tag: 24.04.2_v6.8.4-rt11-raspi_ros2_jazzy
release_page: true
# One entry per document. revision: YEAR.LETTER, a new letter for every published revision of that document.
# status: draft until the document is published; published: the date of the revision's publication, or null.
# guide: true for the software guides, which describe one runtime version (docs_version) and show it.
manuals:
par6:
number: SR-1001
title: PAR6 Hardware Manual
revision: 2026.A
status: draft
published: null
applies_to: PAR6 arm, revision v1.x
covers: "the arm: safety, technical data, installation, operation, maintenance"
rcb:
number: SR-2001
title: Robot Control Box Manual
revision: 2026.A
status: draft
published: null
guide: true
applies_to: control box PCB v1 and v2
covers: "the control box: hardware, software setup, configuration, operation"
msg:
number: SR-3001
title: MSG Gripper Manual
revision: 2026.A
status: draft
published: null
applies_to: MSG grippers, revision v1.x
covers: the MSG electric grippers
ssg48:
number: SR-3002
title: SSG48 Gripper Manual
revision: 2026.A
status: draft
published: null
applies_to: SSG48 gripper, revision v1.x
covers: the SSG48 electric gripper
pneumatic:
number: SR-3003
title: Pneumatic Tools Manual
revision: 2026.A
status: draft
published: null
applies_to: pneumatic gripper and vacuum tool, revision v1.x
covers: the pneumatic gripper and the vacuum tool
programming:
number: SR-4001
title: Programming Guide
revision: 2026.A
status: draft
published: null
guide: true
applies_to: ""
covers: "every way to command the robot: the Python client, the command protocol, the real-time interface, blocks, G-code"
dashboard:
number: SR-4002
title: Dashboard Guide
revision: 2026.A
status: draft
published: null
guide: true
applies_to: ""
covers: the operator web interface
simulation:
number: SR-4003
title: Simulation and AI Guide
revision: 2026.A
status: draft
published: null
guide: true
applies_to: description package 2.0
covers: "the description package, simulators, data collection"