Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@ The hub covers:
## Ecosystem Repositories

### Platform Software

```text
openamr-platform-sw
```

ROS 2 software, simulation, navigation, docking, drivers, perception, and bringup.

**Status:** Active documentation hub; individual subsystem maturity is stated on its page and in its owning repository.

### Platform Firmware

```text
Expand Down Expand Up @@ -96,6 +97,12 @@ openamrobot-docs/
- hardware
- firmware

## Repository boundaries

- Exact versions, parameters, source code and interface contracts remain canonical in their owning repositories.
- This repository owns cross-project architecture, learning paths, durable explanations and the published documentation site.
- Tested commands should be linked to their owning repository instead of copied into multiple locations.

## Documentation Principles

Documentation should be:
Expand Down
4 changes: 4 additions & 0 deletions docs/about/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: About, legal and contact
---

# About, legal and contact

## Project and operator
Expand Down
6 changes: 5 additions & 1 deletion docs/academy/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<section class="oamr-hero"><div><span class="oamr-status">Botshare Academy</span><h1>Train the people who own the task</h1><p>Practical Embodied AI education for operators, builders, integrators and domain experts – built on the real OpenAMRobot platform.</p><div class="oamr-actions"><a class="oamr-button oamr-button--primary" href="programs/">Explore programs</a><a class="oamr-button" href="partner-program/">Become a training partner</a></div></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>
---
title: Botshare Academy
---

<section class="oamr-hero"><div><span class="oamr-status">Botshare Academy</span><h1>Train the people who own the task</h1><p>Practical Embodied AI education for Domain Experts, beginners, integrators, builders and developers – built on the real OpenAMRobot platform.</p><div class="oamr-actions"><a class="oamr-button oamr-button--primary" href="programs/">Explore programs</a><a class="oamr-button" href="partner-program/">Become a training partner</a></div></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>

> **Domain expertise – not coding – becomes the programming interface.**

Expand Down
10 changes: 5 additions & 5 deletions docs/build/acceptance/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Acceptance
---

<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Acceptance</h1><p>Provide a safe, numbered and verifiable procedure for acceptance during a physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>
<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Acceptance</h1><p>Plan and verify acceptance as part of a controlled physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>

!!! info "Documentation framework"
This page is part of the approved OpenAMRobot knowledge architecture. It is intentionally published before full content is complete so contributors can fill it consistently. Do not treat unfinished guidance as a validated build or deployment instruction.

## What this page should contain
## Planned coverage

- **Audience and outcome:** who uses this page and what verified state they should reach.
- **Prerequisites:** required skills, tools, hardware, software, configuration and safety conditions.
Expand All @@ -16,11 +16,11 @@ title: Acceptance
- **Troubleshooting:** likely failures, evidence to collect and safe recovery actions.
- **Next step:** one clear continuation in the ownership or development path.

## Content template
## Completion criteria

| Field | To complete |
| Field | Required content |
| --- | --- |
| For | Name one primary reader: operator, builder, integrator or developer |
| For | Name the primary path: Domain Expert, Beginner, Integrator, Builder, Developer or Entrepreneur |
| Before you start | List exact prerequisites or state “nothing” |
| When you finish | Describe a measurable outcome |
| Capability status | Stable, beta, experimental, planned, community or partner-supported |
Expand Down
10 changes: 5 additions & 5 deletions docs/build/assembly/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Assembly
---

<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Assembly</h1><p>Provide a safe, numbered and verifiable procedure for assembly during a physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>
<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Assembly</h1><p>Plan and verify assembly as part of a controlled physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>

!!! info "Documentation framework"
This page is part of the approved OpenAMRobot knowledge architecture. It is intentionally published before full content is complete so contributors can fill it consistently. Do not treat unfinished guidance as a validated build or deployment instruction.

## What this page should contain
## Planned coverage

- **Audience and outcome:** who uses this page and what verified state they should reach.
- **Prerequisites:** required skills, tools, hardware, software, configuration and safety conditions.
Expand All @@ -16,11 +16,11 @@ title: Assembly
- **Troubleshooting:** likely failures, evidence to collect and safe recovery actions.
- **Next step:** one clear continuation in the ownership or development path.

## Content template
## Completion criteria

| Field | To complete |
| Field | Required content |
| --- | --- |
| For | Name one primary reader: operator, builder, integrator or developer |
| For | Name the primary path: Domain Expert, Beginner, Integrator, Builder, Developer or Entrepreneur |
| Before you start | List exact prerequisites or state “nothing” |
| When you finish | Describe a measurable outcome |
| Capability status | Stable, beta, experimental, planned, community or partner-supported |
Expand Down
52 changes: 13 additions & 39 deletions docs/build/bringup/index.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,22 @@
---
title: Bringup
title: Bring-up
---

<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Bringup</h1><p>Provide a safe, numbered and verifiable procedure for bringup during a physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>
<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Hardware validation in progress</span><h1>Bring up one subsystem at a time</h1><p>Verify power, communication, motors and sensors before permitting normal robot motion.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>

!!! info "Documentation framework"
This page is part of the approved OpenAMRobot knowledge architecture. It is intentionally published before full content is complete so contributors can fill it consistently. Do not treat unfinished guidance as a validated build or deployment instruction.
## Controlled sequence

## What this page should contain
<div class="oamr-path"><span>Pre-power</span><b>→</b><span>First power</span><b>→</b><span>Motor check</span><b>→</b><span>Sensor check</span><b>→</b><span>First motion</span></div>

- **Audience and outcome:** who uses this page and what verified state they should reach.
- **Prerequisites:** required skills, tools, hardware, software, configuration and safety conditions.
- **Concept or procedure:** concise explanation followed by ordered, reproducible steps where applicable.
- **Verification:** observable output, measurement, test or acceptance criterion.
- **Troubleshooting:** likely failures, evidence to collect and safe recovery actions.
- **Next step:** one clear continuation in the ownership or development path.

## Content template

| Field | To complete |
| Checkpoint | Continue only when |
| --- | --- |
| For | Name one primary reader: operator, builder, integrator or developer |
| Before you start | List exact prerequisites or state “nothing” |
| When you finish | Describe a measurable outcome |
| Capability status | Stable, beta, experimental, planned, community or partner-supported |
| Applies to | Release, hardware revision and configuration |
| Safety | Hazards, limits, stop conditions and required supervision |
| Verification | What the reader should see, hear, measure or test |

### Procedure or explanation

1. Establish the starting state.
2. Complete one action or concept per subsection.
3. Record commands, parameters, screenshots or measurements where useful.
4. Verify the result before continuing.

### If it did not work

Document symptoms separately from causes. Include diagnostic evidence and a safe rollback or escalation path.

## Owning OpenAMRobot source

- [openamr-platform-sw](https://github.com/openAMRobot/openamr-platform-sw) – canonical source, versions, implementation and issue history.
| [Pre-power](pre-power-checklist.md) | Polarity, protection, grounding, connectors and mechanical clearances are verified |
| [First power-on](first-power-on.md) | Rails are stable, no component overheats and the system can be stopped immediately |
| [Motor and drive check](motor-check.md) | Direction, encoder feedback and commanded speed agree with the configuration |
| [Sensor check](sensor-check.md) | Expected ROS 2 topics update with plausible frames, rates and values |
| [First motion](first-motion.md) | The robot moves at reduced limits in a controlled area and stops as expected |

## Contribution note
Record hardware revision, firmware commit, software release, robot profile and every measured result. Stop at the first unexpected state and use [common bring-up failures](common-bringup-failures.md) to collect evidence before changing multiple variables.

Replace this framework with tested project-specific content through the normal [contribution workflow](https://github.com/openAMRobot/openamrobot-docs/blob/main/CONTRIBUTING.md). Keep exact parameters and contracts synchronized with the owning repository.
!!! warning "Not yet a released real-robot procedure"
The owning software repository marks real-robot drivers and control as in progress. Treat these pages as the acceptance structure for tested contributions, not proof that every physical configuration is supported today.
10 changes: 5 additions & 5 deletions docs/build/calibration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Calibration
---

<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Calibration</h1><p>Provide a safe, numbered and verifiable procedure for calibration during a physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>
<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Calibration</h1><p>Plan and verify calibration as part of a controlled physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>

!!! info "Documentation framework"
This page is part of the approved OpenAMRobot knowledge architecture. It is intentionally published before full content is complete so contributors can fill it consistently. Do not treat unfinished guidance as a validated build or deployment instruction.

## What this page should contain
## Planned coverage

- **Audience and outcome:** who uses this page and what verified state they should reach.
- **Prerequisites:** required skills, tools, hardware, software, configuration and safety conditions.
Expand All @@ -16,11 +16,11 @@ title: Calibration
- **Troubleshooting:** likely failures, evidence to collect and safe recovery actions.
- **Next step:** one clear continuation in the ownership or development path.

## Content template
## Completion criteria

| Field | To complete |
| Field | Required content |
| --- | --- |
| For | Name one primary reader: operator, builder, integrator or developer |
| For | Name the primary path: Domain Expert, Beginner, Integrator, Builder, Developer or Entrepreneur |
| Before you start | List exact prerequisites or state “nothing” |
| When you finish | Describe a measurable outcome |
| Capability status | Stable, beta, experimental, planned, community or partner-supported |
Expand Down
10 changes: 5 additions & 5 deletions docs/build/electronics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Electronics
---

<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Electronics</h1><p>Provide a safe, numbered and verifiable procedure for electronics during a physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>
<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Electronics</h1><p>Plan and verify electronics as part of a controlled physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>

!!! info "Documentation framework"
This page is part of the approved OpenAMRobot knowledge architecture. It is intentionally published before full content is complete so contributors can fill it consistently. Do not treat unfinished guidance as a validated build or deployment instruction.

## What this page should contain
## Planned coverage

- **Audience and outcome:** who uses this page and what verified state they should reach.
- **Prerequisites:** required skills, tools, hardware, software, configuration and safety conditions.
Expand All @@ -16,11 +16,11 @@ title: Electronics
- **Troubleshooting:** likely failures, evidence to collect and safe recovery actions.
- **Next step:** one clear continuation in the ownership or development path.

## Content template
## Completion criteria

| Field | To complete |
| Field | Required content |
| --- | --- |
| For | Name one primary reader: operator, builder, integrator or developer |
| For | Name the primary path: Domain Expert, Beginner, Integrator, Builder, Developer or Entrepreneur |
| Before you start | List exact prerequisites or state “nothing” |
| When you finish | Describe a measurable outcome |
| Capability status | Stable, beta, experimental, planned, community or partner-supported |
Expand Down
50 changes: 15 additions & 35 deletions docs/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,23 @@
title: Build
---

<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--planned">Under development</span><h1>Build</h1><p>Provide a safe, numbered and verifiable procedure for build during a physical build.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>
<section class="oamr-hero oamr-hero--compact"><div><span class="oamr-status oamr-status--experimental">Experimental build path</span><h1>Build a platform you can verify</h1><p>Move from workspace and parts to assembly, software, calibration and a recorded acceptance baseline.</p></div><img src="https://avatars.githubusercontent.com/u/175850144?v=4" alt="OpenAMRobot logo"></section>

!!! info "Documentation framework"
This page is part of the approved OpenAMRobot knowledge architecture. It is intentionally published before full content is complete so contributors can fill it consistently. Do not treat unfinished guidance as a validated build or deployment instruction.
## Build sequence

## What this page should contain
<div class="oamr-path"><span>Prepare</span><b>→</b><span>Source</span><b>→</b><span>Assemble</span><b>→</b><span>Install</span><b>→</b><span>Bring up</span><b>→</b><span>Calibrate</span><b>→</b><span>Accept</span></div>

- **Audience and outcome:** who uses this page and what verified state they should reach.
- **Prerequisites:** required skills, tools, hardware, software, configuration and safety conditions.
- **Concept or procedure:** concise explanation followed by ordered, reproducible steps where applicable.
- **Verification:** observable output, measurement, test or acceptance criterion.
- **Troubleshooting:** likely failures, evidence to collect and safe recovery actions.
- **Next step:** one clear continuation in the ownership or development path.
| Stage | Outcome | Start here |
| --- | --- | --- |
| Prepare | Safe workspace, tools, skills and realistic plan | [Before you start](prepare/index.md) |
| Source | BOM and revision-matched parts are available | [The kit](kit/index.md) |
| Assemble | Mechanics, electronics and wiring match the design source | [Assembly](assembly/index.md) |
| Install | Firmware and ROS 2 software are installed and identified | [Getting software onto the robot](software/index.md) |
| Bring up | Power, motors, sensors and first motion pass controlled checks | [Bring-up](bringup/index.md) |
| Calibrate | Odometry and sensor geometry have recorded baselines | [Calibration](calibration/index.md) |
| Accept | The configuration passes measurable acceptance tests | [Acceptance](acceptance/index.md) |

## Content template
The canonical CAD, BOM and manufacturing source is in [`openamr-platform-hw`](https://github.com/openAMRobot/openamr-platform-hw). Embedded control belongs to [`openamr-platform-fw`](https://github.com/openAMRobot/openamr-platform-fw), and ROS 2 integration belongs to [`openamr-platform-sw`](https://github.com/openAMRobot/openamr-platform-sw).

| Field | To complete |
| --- | --- |
| For | Name one primary reader: operator, builder, integrator or developer |
| Before you start | List exact prerequisites or state “nothing” |
| When you finish | Describe a measurable outcome |
| Capability status | Stable, beta, experimental, planned, community or partner-supported |
| Applies to | Release, hardware revision and configuration |
| Safety | Hazards, limits, stop conditions and required supervision |
| Verification | What the reader should see, hear, measure or test |

### Procedure or explanation

1. Establish the starting state.
2. Complete one action or concept per subsection.
3. Record commands, parameters, screenshots or measurements where useful.
4. Verify the result before continuing.

### If it did not work

Document symptoms separately from causes. Include diagnostic evidence and a safe rollback or escalation path.

## Contribution note

Replace this framework with tested project-specific content through the normal [contribution workflow](https://github.com/openAMRobot/openamrobot-docs/blob/main/CONTRIBUTING.md). Keep exact parameters and contracts synchronized with the owning repository.
!!! warning "Current maturity"
The released source is suitable for study and development. Simulation, Nav2 and docking run end to end; real-robot drivers, control and hardware acceptance documentation remain in progress. Do not treat an unfinished page as a validated safety or manufacturing instruction.
Loading
Loading