From 3b978b0de0af72935e661b2c1700e74b90a9aa52 Mon Sep 17 00:00:00 2001 From: Alex Reznichenko Date: Tue, 1 Sep 2026 04:21:58 +0300 Subject: [PATCH] docs: replace scaffold leakage and refine navigation UI Signed-off-by: Alex Reznichenko --- README.md | 9 ++- docs/about/index.md | 4 ++ docs/academy/index.md | 6 +- docs/build/acceptance/index.md | 10 ++-- docs/build/assembly/index.md | 10 ++-- docs/build/bringup/index.md | 52 +++++------------- docs/build/calibration/index.md | 10 ++-- docs/build/electronics/index.md | 10 ++-- docs/build/index.md | 50 +++++------------ docs/build/kit/index.md | 10 ++-- docs/build/prepare/index.md | 10 ++-- docs/build/software/index.md | 10 ++-- docs/business/index.md | 4 ++ docs/community/index.md | 4 ++ docs/configure/configuration-model/index.md | 10 ++-- docs/configure/docking-config/index.md | 10 ++-- docs/configure/index.md | 53 +++++------------- docs/configure/manipulation-config/index.md | 10 ++-- docs/configure/navigation-tuning/index.md | 10 ++-- docs/configure/network/index.md | 10 ++-- docs/configure/robot-description/index.md | 10 ++-- docs/configure/safety-limits/index.md | 10 ++-- docs/configure/sensors/index.md | 10 ++-- docs/contributing/index.md | 4 ++ docs/customize/ai/index.md | 10 ++-- docs/customize/device-packages/index.md | 10 ++-- docs/customize/firmware/index.md | 10 ++-- docs/customize/hardware/index.md | 10 ++-- docs/customize/index.md | 50 +++++------------ docs/customize/integration/index.md | 10 ++-- docs/customize/simulation/index.md | 10 ++-- docs/customize/software/index.md | 10 ++-- docs/foundations/embodied-ai/index.md | 10 ++-- docs/foundations/index.md | 49 +++++------------ docs/foundations/manipulation/index.md | 10 ++-- docs/foundations/navigation/index.md | 10 ++-- docs/foundations/robot-anatomy/index.md | 10 ++-- docs/foundations/ros2/index.md | 10 ++-- docs/foundations/safety/index.md | 10 ++-- docs/index.md | 3 +- docs/javascripts/site-enhancements.js | 28 +++++++--- docs/learn/index.md | 4 ++ docs/llms.txt | 31 +++++++++++ docs/maintain/diagnosis/index.md | 10 ++-- docs/maintain/faults/index.md | 10 ++-- docs/maintain/index.md | 54 +++++------------- docs/maintain/repair/index.md | 10 ++-- docs/maintain/routine/index.md | 10 ++-- docs/maintain/updates/index.md | 10 ++-- docs/paths/index.md | 4 ++ docs/reference/index.md | 4 ++ .../reference/openamr-platform-fw/overview.md | 53 +++++------------- .../reference/openamr-platform-hw/overview.md | 53 +++++------------- .../reference/openamr-platform-sw/overview.md | 51 ++++------------- .../openamrobot-interfaces/overview.md | 50 +++-------------- .../openamrobot-manifest/overview.md | 51 +++-------------- .../reference/openamrobot-release/overview.md | 51 ++++------------- docs/reference/openamrobot-ui/overview.md | 52 ++++-------------- docs/safety/index.md | 4 ++ docs/solutions/index.md | 4 ++ docs/start-here/index.md | 1 + docs/stylesheets/brand.css | 55 +++++++++++++++---- docs/troubleshooting/index.md | 4 ++ docs/tutorials/index.md | 4 ++ docs/ui/index.md | 6 +- docs/use/blockly/index.md | 10 ++-- docs/use/demonstration/index.md | 54 +++++------------- docs/use/driving/index.md | 10 ++-- docs/use/index.md | 54 +++++------------- docs/use/locations/index.md | 10 ++-- docs/use/mapping/index.md | 10 ++-- docs/use/missions/index.md | 10 ++-- docs/use/monitoring/index.md | 10 ++-- 73 files changed, 543 insertions(+), 807 deletions(-) create mode 100644 docs/llms.txt diff --git a/README.md b/README.md index 64e1079..0436a68 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: diff --git a/docs/about/index.md b/docs/about/index.md index 7eab527..c1fe1e8 100644 --- a/docs/about/index.md +++ b/docs/about/index.md @@ -1,3 +1,7 @@ +--- +title: About, legal and contact +--- + # About, legal and contact ## Project and operator diff --git a/docs/academy/index.md b/docs/academy/index.md index e3a5c7b..d0f56a8 100644 --- a/docs/academy/index.md +++ b/docs/academy/index.md @@ -1,4 +1,8 @@ -
Botshare Academy

Train the people who own the task

Practical Embodied AI education for operators, builders, integrators and domain experts – built on the real OpenAMRobot platform.

Explore programsBecome a training partner
OpenAMRobot logo
+--- +title: Botshare Academy +--- + +
Botshare Academy

Train the people who own the task

Practical Embodied AI education for Domain Experts, beginners, integrators, builders and developers – built on the real OpenAMRobot platform.

Explore programsBecome a training partner
OpenAMRobot logo
> **Domain expertise – not coding – becomes the programming interface.** diff --git a/docs/build/acceptance/index.md b/docs/build/acceptance/index.md index 60848dc..a7efcab 100644 --- a/docs/build/acceptance/index.md +++ b/docs/build/acceptance/index.md @@ -2,12 +2,12 @@ title: Acceptance --- -
Under development

Acceptance

Provide a safe, numbered and verifiable procedure for acceptance during a physical build.

OpenAMRobot logo
+
Under development

Acceptance

Plan and verify acceptance as part of a controlled physical build.

OpenAMRobot logo
!!! 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. @@ -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 | diff --git a/docs/build/assembly/index.md b/docs/build/assembly/index.md index 0fa0076..3f6e849 100644 --- a/docs/build/assembly/index.md +++ b/docs/build/assembly/index.md @@ -2,12 +2,12 @@ title: Assembly --- -
Under development

Assembly

Provide a safe, numbered and verifiable procedure for assembly during a physical build.

OpenAMRobot logo
+
Under development

Assembly

Plan and verify assembly as part of a controlled physical build.

OpenAMRobot logo
!!! 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. @@ -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 | diff --git a/docs/build/bringup/index.md b/docs/build/bringup/index.md index e1d5d86..b6ac4c2 100644 --- a/docs/build/bringup/index.md +++ b/docs/build/bringup/index.md @@ -1,48 +1,22 @@ --- -title: Bringup +title: Bring-up --- -
Under development

Bringup

Provide a safe, numbered and verifiable procedure for bringup during a physical build.

OpenAMRobot logo
+
Hardware validation in progress

Bring up one subsystem at a time

Verify power, communication, motors and sensors before permitting normal robot motion.

OpenAMRobot logo
-!!! 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 +
Pre-power→First power→Motor check→Sensor check→First motion
-- **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. diff --git a/docs/build/calibration/index.md b/docs/build/calibration/index.md index 6273a51..c6d8a30 100644 --- a/docs/build/calibration/index.md +++ b/docs/build/calibration/index.md @@ -2,12 +2,12 @@ title: Calibration --- -
Under development

Calibration

Provide a safe, numbered and verifiable procedure for calibration during a physical build.

OpenAMRobot logo
+
Under development

Calibration

Plan and verify calibration as part of a controlled physical build.

OpenAMRobot logo
!!! 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. @@ -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 | diff --git a/docs/build/electronics/index.md b/docs/build/electronics/index.md index 442a07a..bcac12c 100644 --- a/docs/build/electronics/index.md +++ b/docs/build/electronics/index.md @@ -2,12 +2,12 @@ title: Electronics --- -
Under development

Electronics

Provide a safe, numbered and verifiable procedure for electronics during a physical build.

OpenAMRobot logo
+
Under development

Electronics

Plan and verify electronics as part of a controlled physical build.

OpenAMRobot logo
!!! 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. @@ -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 | diff --git a/docs/build/index.md b/docs/build/index.md index 930b050..e54c27c 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -2,43 +2,23 @@ title: Build --- -
Under development

Build

Provide a safe, numbered and verifiable procedure for build during a physical build.

OpenAMRobot logo
+
Experimental build path

Build a platform you can verify

Move from workspace and parts to assembly, software, calibration and a recorded acceptance baseline.

OpenAMRobot logo
-!!! 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 +
Prepare→Source→Assemble→Install→Bring up→Calibrate→Accept
-- **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. diff --git a/docs/build/kit/index.md b/docs/build/kit/index.md index 525dac4..e00c9e2 100644 --- a/docs/build/kit/index.md +++ b/docs/build/kit/index.md @@ -2,12 +2,12 @@ title: Kit --- -
Under development

Kit

Provide a safe, numbered and verifiable procedure for kit during a physical build.

OpenAMRobot logo
+
Under development

Kit

Plan and verify kit as part of a controlled physical build.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Kit - **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 | diff --git a/docs/build/prepare/index.md b/docs/build/prepare/index.md index 6859ea5..19df558 100644 --- a/docs/build/prepare/index.md +++ b/docs/build/prepare/index.md @@ -2,12 +2,12 @@ title: Prepare --- -
Under development

Prepare

Provide a safe, numbered and verifiable procedure for prepare during a physical build.

OpenAMRobot logo
+
Under development

Prepare

Plan and verify prepare as part of a controlled physical build.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Prepare - **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 | diff --git a/docs/build/software/index.md b/docs/build/software/index.md index b509326..8281a3c 100644 --- a/docs/build/software/index.md +++ b/docs/build/software/index.md @@ -2,12 +2,12 @@ title: Software --- -
Under development

Software

Provide a safe, numbered and verifiable procedure for software during a physical build.

OpenAMRobot logo
+
Under development

Software

Plan and verify software as part of a controlled physical build.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Software - **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 | diff --git a/docs/business/index.md b/docs/business/index.md index e5c8bb5..5c47f9f 100644 --- a/docs/business/index.md +++ b/docs/business/index.md @@ -1,3 +1,7 @@ +--- +title: Build a business +--- +
Build a business

Create value around an open platform

Build local capability in training, integration, pilots, hardware, deployment and support – without starting a robotics ecosystem from zero.

Choose a modelExplore partnership
OpenAMRobot logo
> Open source lowers the barrier to building. A successful business still requires customer access, delivery competence, quality, support and measurable outcomes. diff --git a/docs/community/index.md b/docs/community/index.md index 2ffcb89..9ff3a48 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -1,3 +1,7 @@ +--- +title: Community and GitHub +--- + # OpenAMRobot Community & GitHub OpenAMRobot is developed in the open across a growing set of public repositories for software, firmware, hardware, interfaces, documentation, UI, releases, and manipulation. diff --git a/docs/configure/configuration-model/index.md b/docs/configure/configuration-model/index.md index 0bb7970..25fffd4 100644 --- a/docs/configure/configuration-model/index.md +++ b/docs/configure/configuration-model/index.md @@ -2,12 +2,12 @@ title: Configuration Model --- -
Under development

Configuration Model

Document supported settings, defaults, effects and verification for configuration model.

OpenAMRobot logo
+
Under development

Configuration Model

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Configuration Model - **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 | diff --git a/docs/configure/docking-config/index.md b/docs/configure/docking-config/index.md index 7d02e9e..259c413 100644 --- a/docs/configure/docking-config/index.md +++ b/docs/configure/docking-config/index.md @@ -2,12 +2,12 @@ title: Docking Config --- -
Under development

Docking Config

Document supported settings, defaults, effects and verification for docking config.

OpenAMRobot logo
+
Under development

Docking Config

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Docking Config - **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 | diff --git a/docs/configure/index.md b/docs/configure/index.md index acf82f5..d1908f2 100644 --- a/docs/configure/index.md +++ b/docs/configure/index.md @@ -2,47 +2,20 @@ title: Configure --- -
Under development

Configure

Document supported settings, defaults, effects and verification for configure.

OpenAMRobot logo
+
Experimental

Turn source into a reproducible robot profile

Describe geometry, sensors, navigation, docking, safety limits and networking without hiding which release and hardware revision they apply to.

OpenAMRobot logo
-!!! 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. +## Configuration map -## What this page should contain +| Area | Owns | Verify by | +| --- | --- | --- | +| [Configuration model](configuration-model/index.md) | Profiles, versions, backup and restore | Rebuilding the same effective configuration from source | +| [Robot description](robot-description/index.md) | URDF, joints, limits and collision geometry | Inspecting TF, joint limits and collision models | +| [Sensors](sensors/index.md) | Frames, drivers and sensor-specific parameters | Checking topic rates, frames and plausible values | +| [Navigation](navigation-tuning/index.md) | Costmaps, planners, controllers and motion limits | Running repeatable navigation scenarios | +| [Docking](docking-config/index.md) | Target geometry, detection, approach and charging | Repeating dock/undock tests from defined starts | +| [Safety limits](safety-limits/index.md) | Speed, zones, stop behaviour and supervision | Testing every limit and stop condition | +| [Network](network/index.md) | Wi-Fi, DDS, remote UI and access boundaries | Reconnecting and operating from the intended topology | -- **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. +
Select release→Identify hardware→Apply profile→Verify→Record baseline
-## Content template - -| 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. - -## Owning OpenAMRobot source - -- [openamr-platform-sw](https://github.com/openAMRobot/openamr-platform-sw) – canonical source, versions, implementation and issue history. - -## 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. +Exact defaults and parameters are canonical in [`openamr-platform-sw`](https://github.com/openAMRobot/openamr-platform-sw). This site explains their purpose, dependencies and verification sequence. diff --git a/docs/configure/manipulation-config/index.md b/docs/configure/manipulation-config/index.md index 5bc85d8..e8f6b18 100644 --- a/docs/configure/manipulation-config/index.md +++ b/docs/configure/manipulation-config/index.md @@ -2,12 +2,12 @@ title: Manipulation Config --- -
Under development

Manipulation Config

Document supported settings, defaults, effects and verification for manipulation config.

OpenAMRobot logo
+
Under development

Manipulation Config

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Manipulation Config - **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 | diff --git a/docs/configure/navigation-tuning/index.md b/docs/configure/navigation-tuning/index.md index a48f8cd..780ccba 100644 --- a/docs/configure/navigation-tuning/index.md +++ b/docs/configure/navigation-tuning/index.md @@ -2,12 +2,12 @@ title: Navigation Tuning --- -
Under development

Navigation Tuning

Document supported settings, defaults, effects and verification for navigation tuning.

OpenAMRobot logo
+
Under development

Navigation Tuning

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Navigation Tuning - **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 | diff --git a/docs/configure/network/index.md b/docs/configure/network/index.md index 25b725e..a9124f4 100644 --- a/docs/configure/network/index.md +++ b/docs/configure/network/index.md @@ -2,12 +2,12 @@ title: Network --- -
Under development

Network

Document supported settings, defaults, effects and verification for network.

OpenAMRobot logo
+
Under development

Network

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Network - **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 | diff --git a/docs/configure/robot-description/index.md b/docs/configure/robot-description/index.md index 9f8cbef..fc023d5 100644 --- a/docs/configure/robot-description/index.md +++ b/docs/configure/robot-description/index.md @@ -2,12 +2,12 @@ title: Robot Description --- -
Under development

Robot Description

Document supported settings, defaults, effects and verification for robot description.

OpenAMRobot logo
+
Under development

Robot Description

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Robot Description - **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 | diff --git a/docs/configure/safety-limits/index.md b/docs/configure/safety-limits/index.md index 1d2494c..593b0c2 100644 --- a/docs/configure/safety-limits/index.md +++ b/docs/configure/safety-limits/index.md @@ -2,12 +2,12 @@ title: Safety Limits --- -
Under development

Safety Limits

Document supported settings, defaults, effects and verification for safety limits.

OpenAMRobot logo
+
Under development

Safety Limits

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Safety Limits - **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 | diff --git a/docs/configure/sensors/index.md b/docs/configure/sensors/index.md index a1e740f..ae236f4 100644 --- a/docs/configure/sensors/index.md +++ b/docs/configure/sensors/index.md @@ -2,12 +2,12 @@ title: Sensors --- -
Under development

Sensors

Document supported settings, defaults, effects and verification for sensors.

OpenAMRobot logo
+
Under development

Sensors

Understand supported settings, their effects and how to verify them.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Sensors - **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 | diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 81d0b7d..c3dbe76 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -1,3 +1,7 @@ +--- +title: Contributing +--- + # Contributing OpenAMRobot welcomes technically justified contributions through pull requests. diff --git a/docs/customize/ai/index.md b/docs/customize/ai/index.md index c3395de..0570059 100644 --- a/docs/customize/ai/index.md +++ b/docs/customize/ai/index.md @@ -2,12 +2,12 @@ title: AI --- -
Under development

AI

Show how to extend ai without breaking platform contracts.

OpenAMRobot logo
+
Under development

AI

Extend ai while preserving platform contracts.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: AI - **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 | diff --git a/docs/customize/device-packages/index.md b/docs/customize/device-packages/index.md index 85b4c41..a4bae6b 100644 --- a/docs/customize/device-packages/index.md +++ b/docs/customize/device-packages/index.md @@ -2,12 +2,12 @@ title: Device Packages --- -
Under development

Device Packages

Show how to extend device packages without breaking platform contracts.

OpenAMRobot logo
+
Under development

Device Packages

Extend device packages while preserving platform contracts.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Device Packages - **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 | diff --git a/docs/customize/firmware/index.md b/docs/customize/firmware/index.md index a9e6839..4ce1330 100644 --- a/docs/customize/firmware/index.md +++ b/docs/customize/firmware/index.md @@ -2,12 +2,12 @@ title: Firmware --- -
Under development

Firmware

Show how to extend firmware without breaking platform contracts.

OpenAMRobot logo
+
Under development

Firmware

Extend firmware while preserving platform contracts.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Firmware - **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 | diff --git a/docs/customize/hardware/index.md b/docs/customize/hardware/index.md index 6db5202..0f851c5 100644 --- a/docs/customize/hardware/index.md +++ b/docs/customize/hardware/index.md @@ -2,12 +2,12 @@ title: Hardware --- -
Under development

Hardware

Show how to extend hardware without breaking platform contracts.

OpenAMRobot logo
+
Under development

Hardware

Extend hardware while preserving platform contracts.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Hardware - **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 | diff --git a/docs/customize/index.md b/docs/customize/index.md index 8a59fb6..0cd59d4 100644 --- a/docs/customize/index.md +++ b/docs/customize/index.md @@ -2,43 +2,23 @@ title: Customize --- -
Under development

Customize

Show how to extend customize without breaking platform contracts.

OpenAMRobot logo
+
Mixed maturity

Extend the platform through owned contracts

Add devices, code, firmware, hardware, simulations or policies without duplicating another repository's responsibility.

OpenAMRobot logo
-!!! 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. +## Choose the owning layer -## What this page should contain +| Extension | Owning source | Start here | +| --- | --- | --- | +| ROS 2 behaviour and platform integration | `openamr-platform-sw` | [Software](software/index.md) | +| Embedded control and bridges | `openamr-platform-fw` | [Firmware](firmware/index.md) | +| Chassis, power and electronics | `openamr-platform-hw` | [Hardware](hardware/index.md) | +| Shared messages, services and actions | `openamrobot-interfaces` | [Working with interfaces](software/working-with-interfaces.md) | +| UI panels and Blockly blocks | `openamrobot-ui` | [Extending the UI](software/extending-the-ui.md) | +| Reusable arms and devices | `openamrobot-manipulation` | [Device packages](device-packages/index.md) | +| Worlds and scenario validation | Owning software repository | [Simulation](simulation/index.md) | +| Datasets and policies | Developing manipulation/AI layer | [AI and policies](ai/index.md) | -- **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. +
Choose contract→Check maturity→Implement→Test→Document→Contribute
-## Content template +The mobile simulation, navigation and docking stack is active but experimental. The shared manipulation framework and upper-body repositories are planned for the v0.2 cycle and simulation-first; their current contracts are design direction, not released implementation. -| 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. +Use the [repository map](../reference/repositories.md) before changing a contract and follow the [contribution workflow](../community/contributing.md) for DCO, contributor agreement, review and testing requirements. diff --git a/docs/customize/integration/index.md b/docs/customize/integration/index.md index 4b6c868..02031dc 100644 --- a/docs/customize/integration/index.md +++ b/docs/customize/integration/index.md @@ -2,12 +2,12 @@ title: Integration --- -
Under development

Integration

Show how to extend integration without breaking platform contracts.

OpenAMRobot logo
+
Under development

Integration

Extend integration while preserving platform contracts.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Integration - **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 | diff --git a/docs/customize/simulation/index.md b/docs/customize/simulation/index.md index ff05a95..e6fd4f4 100644 --- a/docs/customize/simulation/index.md +++ b/docs/customize/simulation/index.md @@ -2,12 +2,12 @@ title: Simulation --- -
Under development

Simulation

Show how to extend simulation without breaking platform contracts.

OpenAMRobot logo
+
Under development

Simulation

Extend simulation while preserving platform contracts.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Simulation - **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 | diff --git a/docs/customize/software/index.md b/docs/customize/software/index.md index 129c07d..076a641 100644 --- a/docs/customize/software/index.md +++ b/docs/customize/software/index.md @@ -2,12 +2,12 @@ title: Software --- -
Under development

Software

Show how to extend software without breaking platform contracts.

OpenAMRobot logo
+
Under development

Software

Extend software while preserving platform contracts.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Software - **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 | diff --git a/docs/foundations/embodied-ai/index.md b/docs/foundations/embodied-ai/index.md index 1227bbf..4c933e7 100644 --- a/docs/foundations/embodied-ai/index.md +++ b/docs/foundations/embodied-ai/index.md @@ -2,12 +2,12 @@ title: Embodied AI --- -
Under development

Embodied AI

Explain embodied ai in plain language and show how it affects OpenAMRobot.

OpenAMRobot logo
+
Under development

Embodied AI

Understand embodied ai and how it affects OpenAMRobot.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Embodied AI - **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 | diff --git a/docs/foundations/index.md b/docs/foundations/index.md index 97af64e..447efbe 100644 --- a/docs/foundations/index.md +++ b/docs/foundations/index.md @@ -2,43 +2,24 @@ title: Foundations --- -
Under development

Foundations

Explain foundations in plain language and show how it affects OpenAMRobot.

OpenAMRobot logo
+
Core concepts

Understand the robot before changing it

Build the mental model needed to work safely with the mobile base, navigation, manipulation, ROS 2 and Embodied AI.

OpenAMRobot logo
-!!! 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 you will understand -## What this page should contain +| Area | Why it matters | Continue with | +| --- | --- | --- | +| Robot anatomy | Connect mechanics, power, compute, sensors and actuators to observable behaviour | [Robot anatomy](robot-anatomy/index.md) | +| Navigation | Understand frames, odometry, SLAM, localization, planning and docking | [How navigation works](navigation/index.md) | +| Manipulation | Understand reach, kinematics, planning, grippers and the lift | [How manipulation works](manipulation/index.md) | +| Embodied AI | See how demonstrations become datasets, policies and evaluated behaviour | [Teaching by demonstration](embodied-ai/index.md) | +| ROS 2 | Read nodes, topics, actions, parameters, TF and launch composition | [ROS 2 in an afternoon](ros2/index.md) | +| Safety | Recognize operating limits, stop conditions and required supervision | [Working safely](safety/index.md) | -- **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. +## Recommended order -## Content template +
Anatomy→Safety→ROS 2→Navigation→Manipulation→Embodied AI
-| 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 | +You do not need every topic before starting. A Domain Expert can begin with safety and operation; a Builder should add anatomy and power; a Developer should complete the ROS 2 and interface material. -### 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. +!!! info "Capability boundary" + Foundations explains system concepts. Exact versions, parameters and interfaces remain in the repository that owns them; the current mobile software stack is experimental, and upper-body/manipulation implementation is planned and simulation-first. diff --git a/docs/foundations/manipulation/index.md b/docs/foundations/manipulation/index.md index 6cdd85a..b4e195c 100644 --- a/docs/foundations/manipulation/index.md +++ b/docs/foundations/manipulation/index.md @@ -2,12 +2,12 @@ title: Manipulation --- -
Under development

Manipulation

Explain manipulation in plain language and show how it affects OpenAMRobot.

OpenAMRobot logo
+
Under development

Manipulation

Understand manipulation and how it affects OpenAMRobot.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Manipulation - **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 | diff --git a/docs/foundations/navigation/index.md b/docs/foundations/navigation/index.md index 10888fc..61f934c 100644 --- a/docs/foundations/navigation/index.md +++ b/docs/foundations/navigation/index.md @@ -2,12 +2,12 @@ title: Navigation --- -
Under development

Navigation

Explain navigation in plain language and show how it affects OpenAMRobot.

OpenAMRobot logo
+
Under development

Navigation

Understand navigation and how it affects OpenAMRobot.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Navigation - **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 | diff --git a/docs/foundations/robot-anatomy/index.md b/docs/foundations/robot-anatomy/index.md index b227421..dc8b329 100644 --- a/docs/foundations/robot-anatomy/index.md +++ b/docs/foundations/robot-anatomy/index.md @@ -2,12 +2,12 @@ title: Robot Anatomy --- -
Under development

Robot Anatomy

Explain robot anatomy in plain language and show how it affects OpenAMRobot.

OpenAMRobot logo
+
Under development

Robot Anatomy

Understand robot anatomy and how it affects OpenAMRobot.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Robot Anatomy - **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 | diff --git a/docs/foundations/ros2/index.md b/docs/foundations/ros2/index.md index 4ef104d..1bc208e 100644 --- a/docs/foundations/ros2/index.md +++ b/docs/foundations/ros2/index.md @@ -2,12 +2,12 @@ title: ROS 2 --- -
Under development

ROS 2

Explain ros 2 in plain language and show how it affects OpenAMRobot.

OpenAMRobot logo
+
Under development

ROS 2

Understand ros 2 and how it affects OpenAMRobot.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: ROS 2 - **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 | diff --git a/docs/foundations/safety/index.md b/docs/foundations/safety/index.md index 29b1df1..58025c0 100644 --- a/docs/foundations/safety/index.md +++ b/docs/foundations/safety/index.md @@ -2,12 +2,12 @@ title: Safety --- -
Under development

Safety

Explain safety in plain language and show how it affects OpenAMRobot.

OpenAMRobot logo
+
Under development

Safety

Understand safety and how it affects OpenAMRobot.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Safety - **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 | diff --git a/docs/index.md b/docs/index.md index f4bf2d1..70de4e6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,5 @@ --- +title: Home hide: - navigation --- @@ -39,7 +40,7 @@ hide:
Active

Mobile platform

ROS 2 Jazzy, Nav2, SLAM, navigation, docking, simulation, firmware and open hardware.

Technical overview →

- +
Developing

Upper body & manipulation

Lift, arm-agnostic manipulation, named poses and mobile-manipulation integration.

See the architecture →

Developing

Demonstration pipeline

Show, Correct, Judge workflows for capturing, replaying and evaluating demonstrations.

Learn how teaching works →

diff --git a/docs/javascripts/site-enhancements.js b/docs/javascripts/site-enhancements.js index 76ada11..604dd3c 100644 --- a/docs/javascripts/site-enhancements.js +++ b/docs/javascripts/site-enhancements.js @@ -70,10 +70,14 @@ list.appendChild(home); let accumulated = ""; - parts.forEach((part, index) => { - accumulated += `/${part}`; + const visibleParts = parts.slice(-2); + const hiddenDepth = parts.length - visibleParts.length; + + visibleParts.forEach((part, index) => { + const sourceIndex = index + hiddenDepth; + accumulated = `/${parts.slice(0, sourceIndex + 1).join("/")}`; const item = document.createElement("li"); - const isLast = index === parts.length - 1; + const isLast = index === visibleParts.length - 1; const label = isLast ? document.querySelector("h1")?.textContent?.trim() || humanize(part) : humanize(part); @@ -105,16 +109,22 @@ const path = window.location.pathname; const rules = [ + [/^\/paths\/domain-expert\//, ["Domain Expert"]], + [/^\/paths\/beginner\//, ["Beginner"]], + [/^\/paths\/integrator\//, ["Integrator"]], + [/^\/paths\/builder\//, ["Builder"]], + [/^\/paths\/developer\//, ["Developer"]], + [/^\/paths\/entrepreneur\//, ["Entrepreneur"]], [/^\/foundations\//, ["Beginner", "Builder"]], [/^\/build\//, ["Builder", "Integrator"]], - [/^\/use\//, ["Operator"]], + [/^\/use\//, ["Domain Expert"]], [/^\/configure\//, ["Integrator"]], [/^\/customize\//, ["Developer", "Integrator"]], - [/^\/maintain\//, ["Operator", "Integrator"]], - [/^\/reference\//, ["Developer"]], + [/^\/maintain\//, ["Domain Expert", "Integrator"]], + [/^\/reference\//, ["Developer", "Integrator"]], [/^\/solutions\//, ["Integrator", "Entrepreneur"]], - [/^\/business\//, ["Entrepreneur", "Partner"]], - [/^\/academy\//, ["Learner", "Partner"]], + [/^\/business\//, ["Entrepreneur"]], + [/^\/academy\//, ["Domain Expert", "Beginner", "Builder", "Developer"]], ]; const match = rules.find(([pattern]) => pattern.test(path)); @@ -122,7 +132,7 @@ const wrapper = document.createElement("div"); wrapper.className = "oamr-track-labels"; - wrapper.setAttribute("aria-label", "Intended reader tracks"); + wrapper.setAttribute("aria-label", "Recommended paths"); match[1].forEach((label) => { const chip = document.createElement("span"); diff --git a/docs/learn/index.md b/docs/learn/index.md index 3bc92d1..13cebd1 100644 --- a/docs/learn/index.md +++ b/docs/learn/index.md @@ -1,3 +1,7 @@ +--- +title: Learning path +--- +
The learning path

From first principles to an owned robot

A staged path to understand, build, configure, train, operate, maintain and customize OpenAMRobot.

Start with foundationsTechnical reference
OpenAMRobot logo
Understand→Build→Bring up→Configure→Train→Use→Maintain→Customize
diff --git a/docs/llms.txt b/docs/llms.txt new file mode 100644 index 0000000..ebbdab2 --- /dev/null +++ b/docs/llms.txt @@ -0,0 +1,31 @@ +# OpenAMRobot Documentation + +> Open-source Embodied AI and mobile robotics knowledge hub operated by Botshare LTD. + +Canonical site: https://docs.openamrobot.ai/ +Source organization: https://github.com/openAMRobot + +## Start + +- https://docs.openamrobot.ai/start-here/ +- https://docs.openamrobot.ai/paths/ +- https://docs.openamrobot.ai/foundations/ +- https://docs.openamrobot.ai/reference/ + +## Platform + +- https://docs.openamrobot.ai/reference/mobile-platform/ +- https://docs.openamrobot.ai/reference/openamr-platform-sw/overview/ +- https://docs.openamrobot.ai/reference/openamr-platform-fw/overview/ +- https://docs.openamrobot.ai/reference/openamr-platform-hw/overview/ +- https://docs.openamrobot.ai/reference/openamrobot-ui/overview/ +- https://docs.openamrobot.ai/reference/openamrobot-interfaces/overview/ +- https://docs.openamrobot.ai/reference/openamrobot-release/overview/ + +## Rules for interpretation + +- The owning GitHub repository is canonical for exact versions, parameters, source and contracts. +- This site explains meaning, selection, workflows and verification. +- Respect the maturity badge on each page. +- Planned or experimental material is not a validated production or safety instruction. +- Software and firmware are generally MIT, documentation CC BY 4.0 and hardware source CERN-OHL-P-2.0; verify the licence and notices in the owning repository. diff --git a/docs/maintain/diagnosis/index.md b/docs/maintain/diagnosis/index.md index 017ace5..01303a8 100644 --- a/docs/maintain/diagnosis/index.md +++ b/docs/maintain/diagnosis/index.md @@ -2,12 +2,12 @@ title: Diagnosis --- -
Under development

Diagnosis

Define inspection, diagnosis, service evidence and acceptance for diagnosis.

OpenAMRobot logo
+
Under development

Diagnosis

Inspect, diagnose and verify diagnosis with recorded service evidence.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Diagnosis - **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 | diff --git a/docs/maintain/faults/index.md b/docs/maintain/faults/index.md index 622e0ff..b8931d3 100644 --- a/docs/maintain/faults/index.md +++ b/docs/maintain/faults/index.md @@ -2,12 +2,12 @@ title: Faults --- -
Under development

Faults

Define inspection, diagnosis, service evidence and acceptance for faults.

OpenAMRobot logo
+
Under development

Faults

Inspect, diagnose and verify faults with recorded service evidence.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Faults - **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 | diff --git a/docs/maintain/index.md b/docs/maintain/index.md index c8a1de8..0a6f3ba 100644 --- a/docs/maintain/index.md +++ b/docs/maintain/index.md @@ -1,48 +1,22 @@ --- -title: Maintain +title: Maintain and repair --- -
Under development

Maintain

Define inspection, diagnosis, service evidence and acceptance for maintain.

OpenAMRobot logo
+
Service framework

Keep evidence with every maintenance action

Separate symptoms from causes, preserve configuration state and verify the robot before returning it to use.

OpenAMRobot logo
-!!! 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. +## Maintenance workflow -## What this page should contain +
Inspect→Capture evidence→Isolate→Repair or update→Verify→Record
-- **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. +| Area | Purpose | Start here | +| --- | --- | --- | +| Routine maintenance | Detect wear, looseness, contamination and drift before failure | [Routine maintenance](routine/index.md) | +| Diagnosis | Read states and logs, reproduce symptoms and isolate one subsystem | [Diagnosis](diagnosis/index.md) | +| Common faults | Follow evidence-led triage by subsystem | [Common faults](faults/index.md) | +| Repair | Restore a known configuration with appropriate parts and records | [Repair](repair/index.md) | +| Updates | Apply versioned software or firmware with a tested rollback | [Updates](updates/index.md) | -## Content template +Before service, make the robot safe against unintended motion and stored energy. After service, repeat the affected acceptance checks and record parts, revisions, commits, configuration changes and results. -| 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. - -## Owning OpenAMRobot source - -- [openamr-platform-hw](https://github.com/openAMRobot/openamr-platform-hw) – canonical source, versions, implementation and issue history. - -## 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. +!!! info "Current scope" + These pages define the documentation and verification structure. Procedures remain planned until tested against an identified hardware revision and release. diff --git a/docs/maintain/repair/index.md b/docs/maintain/repair/index.md index 542c802..0c64998 100644 --- a/docs/maintain/repair/index.md +++ b/docs/maintain/repair/index.md @@ -2,12 +2,12 @@ title: Repair --- -
Under development

Repair

Define inspection, diagnosis, service evidence and acceptance for repair.

OpenAMRobot logo
+
Under development

Repair

Inspect, diagnose and verify repair with recorded service evidence.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Repair - **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 | diff --git a/docs/maintain/routine/index.md b/docs/maintain/routine/index.md index 911ec72..fa00af8 100644 --- a/docs/maintain/routine/index.md +++ b/docs/maintain/routine/index.md @@ -2,12 +2,12 @@ title: Routine --- -
Under development

Routine

Define inspection, diagnosis, service evidence and acceptance for routine.

OpenAMRobot logo
+
Under development

Routine

Inspect, diagnose and verify routine with recorded service evidence.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Routine - **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 | diff --git a/docs/maintain/updates/index.md b/docs/maintain/updates/index.md index 914f4ef..183cd33 100644 --- a/docs/maintain/updates/index.md +++ b/docs/maintain/updates/index.md @@ -2,12 +2,12 @@ title: Updates --- -
Under development

Updates

Define inspection, diagnosis, service evidence and acceptance for updates.

OpenAMRobot logo
+
Under development

Updates

Inspect, diagnose and verify updates with recorded service evidence.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Updates - **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 | diff --git a/docs/paths/index.md b/docs/paths/index.md index 0fe4718..708c228 100644 --- a/docs/paths/index.md +++ b/docs/paths/index.md @@ -1,3 +1,7 @@ +--- +title: Paths +--- + # Paths Choose the path that matches what you need to accomplish now. A person can move between paths as their responsibilities grow. diff --git a/docs/reference/index.md b/docs/reference/index.md index 71582a3..4a83bd0 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,3 +1,7 @@ +--- +title: Technical reference +--- +
Technical reference

Find the owning source

Architecture, repositories, interfaces and subsystem references for people integrating or extending the platform.

Repository mapGitHub organization
OpenAMRobot logo
## Reference map diff --git a/docs/reference/openamr-platform-fw/overview.md b/docs/reference/openamr-platform-fw/overview.md index 40f92a0..e88591a 100644 --- a/docs/reference/openamr-platform-fw/overview.md +++ b/docs/reference/openamr-platform-fw/overview.md @@ -1,48 +1,21 @@ --- -title: Overview +title: openamr-platform-fw overview --- -
Under development

Overview

Provide the learning-layer reference for overview and point to its owning repository.

OpenAMRobot logo
+
Experimental

Mobile platform firmware

Teensy 4.0 micro-ROS motor control, encoder odometry, IMU integration and debug telemetry.

OpenAMRobot logo
-!!! 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. +[`openamr-platform-fw`](https://github.com/openAMRobot/openamr-platform-fw) owns embedded control for the mobile base. The firmware running today is a documented overlay on the pinned `linorobot2_hardware` Jazzy source, not yet the planned modular `firmware/` decomposition. -## What this page should contain - -- **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 | +| Area | Current implementation | | --- | --- | -| 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-fw](https://github.com/openAMRobot/openamr-platform-fw) – canonical source, versions, implementation and issue history. +| Target | Teensy 4.0 | +| Transport | micro-ROS serial agent | +| Motion | Low-level motor control from `/cmd_vel` | +| State | Encoder odometry and raw IMU publication | +| Calibration | Host-side encoder ripple alignment after each Teensy power cycle | +| Diagnostics | `/debug/*` telemetry and gated powered-debug paths | -## Contribution note +Build and flash use PlatformIO plus the Teensy loader. The upstream overlay base is pinned in the repository for reproducibility. -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. +!!! danger "Powered debugging" + Some debug paths command real motors. Keep wheels clear of the ground, maintain a tested physical stop and follow the repository's motion-safety instructions before enabling powered debug. diff --git a/docs/reference/openamr-platform-hw/overview.md b/docs/reference/openamr-platform-hw/overview.md index 12a6e0b..9eff48f 100644 --- a/docs/reference/openamr-platform-hw/overview.md +++ b/docs/reference/openamr-platform-hw/overview.md @@ -1,48 +1,21 @@ --- -title: Overview +title: openamr-platform-hw overview --- -
Under development

Overview

Provide the learning-layer reference for overview and point to its owning repository.

OpenAMRobot logo
+
Experimental · documentation-first

Mobile platform hardware

Maintained CAD, production files, wiring, BOMs, component data and safety notes for the differential-drive base.

OpenAMRobot logo
-!!! 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. +[`openamr-platform-hw`](https://github.com/openAMRobot/openamr-platform-hw) is the canonical source for the physical mobile base. -## What this page should contain - -- **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 | +| Subsystem | Current reference configuration | | --- | --- | -| 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-hw](https://github.com/openAMRobot/openamr-platform-hw) – canonical source, versions, implementation and issue history. +| Compute | Raspberry Pi 5, 8 GB, Ubuntu Server 24.04 and ROS 2 Jazzy | +| Microcontroller | Teensy 4.0; 3.3 V I/O and not 5 V tolerant | +| Drive | Two 24 V, 60 W BLDC geared motors with ZBLD drivers | +| Feedback | AS5040 wheel encoders and MPU6500 IMU | +| Perception | RPLIDAR A1 and Raspberry Pi Camera Module 3 NoIR | +| Geometry | 0.20 m wheel diameter and 0.46 m measured track | -## Contribution note +The repository contains real mechanical CAD, per-part production files, electrical and mechanical BOMs, wiring/pinout documentation, datasheets and safety material. It also documents critical current limitations: no battery fuse, no battery-side disconnect/hardware E-stop, and no active Raspberry Pi 5 cooling in the reference build. -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. +!!! danger "Electrical boundary" + Teensy 4.0 inputs are not 5 V tolerant, and the documented AS5040 encoders must use the 3.3 V rail. Verify the owning repository before wiring or powering hardware. diff --git a/docs/reference/openamr-platform-sw/overview.md b/docs/reference/openamr-platform-sw/overview.md index 8dc4df4..483fbbd 100644 --- a/docs/reference/openamr-platform-sw/overview.md +++ b/docs/reference/openamr-platform-sw/overview.md @@ -1,48 +1,19 @@ --- -title: Overview +title: openamr-platform-sw overview --- -
Under development

Overview

Provide the learning-layer reference for overview and point to its owning repository.

OpenAMRobot logo
+
Experimental

Mobile platform software

ROS 2 Jazzy robot description, Gazebo Harmonic simulation, Nav2 navigation and AprilTag-bundle docking.

OpenAMRobot logo
-!!! 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. +[`openamr-platform-sw`](https://github.com/openAMRobot/openamr-platform-sw) is the owning repository for the mobile base software stack. -## What this page should contain - -- **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 | +| Implemented now | In progress | | --- | --- | -| 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. +| Robot URDF and meshes | Top-level real-robot bring-up | +| Gazebo Harmonic simulation and ROS/Gazebo bridge | `ros2_control` and low-level control integration | +| Nav2, AMCL, SLAM resources and RViz | Production hardware drivers and broader perception | +| Three-tag AprilTag dock/undock sequence | Hardware validation of production docking tolerances | +| Docker and Ubuntu 24.04 setup paths | Rear obstacle awareness during undocking | -## Contribution note +The working simulation composes `openamrobot_description`, `openamrobot_gazebo`, `openamrobot_nav2` and `openamrobot_docking`. CycloneDDS is required by the documented Jazzy setup. The repository reports approximately 1–2 cm lateral and 1° yaw docking performance in simulation; the tighter production target still requires hardware validation. -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. +**Start with:** the repository [quickstart](https://github.com/openAMRobot/openamr-platform-sw#quickstart--simulation-navigation--docking), then use this site for [Foundations](../../foundations/index.md), [Configuration](../../configure/index.md) and the [Beginner path](../../paths/beginner.md). diff --git a/docs/reference/openamrobot-interfaces/overview.md b/docs/reference/openamrobot-interfaces/overview.md index 4ff1bf2..1e08579 100644 --- a/docs/reference/openamrobot-interfaces/overview.md +++ b/docs/reference/openamrobot-interfaces/overview.md @@ -1,48 +1,16 @@ --- -title: Overview +title: openamrobot-interfaces overview --- -
Under development

Overview

Provide the learning-layer reference for overview and point to its owning repository.

OpenAMRobot logo
+
Experimental

Shared interface contracts

One source for reusable ROS 2 messages, services, actions and cross-repository schemas.

OpenAMRobot logo
-!!! 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. +[`openamrobot-interfaces`](https://github.com/openAMRobot/openamrobot-interfaces) separates shared contracts from application logic so the platform software, UI, simulation and future integrations do not redefine the same interface. -## What this page should contain - -- **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 | +| Belongs here | Belongs elsewhere | | --- | --- | -| 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 - -- [openamrobot-interfaces](https://github.com/openAMRobot/openamrobot-interfaces) – canonical source, versions, implementation and issue history. - -## Contribution note +| Shared ROS 2 messages, services and actions | Navigation, docking or application behaviour | +| Reusable JSON/YAML schemas | Hardware drivers and embedded implementation | +| Versioning and interoperability rules | UI components and presentation logic | +| Transport-independent contracts where practical | Middleware bridges and deployment configuration | -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. +Consumers should depend on the shared package and treat incompatible contract changes as versioned migrations. Concrete behaviour remains in the repository that implements it. diff --git a/docs/reference/openamrobot-manifest/overview.md b/docs/reference/openamrobot-manifest/overview.md index af27b87..4234b28 100644 --- a/docs/reference/openamrobot-manifest/overview.md +++ b/docs/reference/openamrobot-manifest/overview.md @@ -1,48 +1,15 @@ --- -title: Overview +title: openamrobot-manifest overview --- -
Under development

Overview

Provide the learning-layer reference for overview and point to its owning repository.

OpenAMRobot logo
+
Active

Assemble the source workspace

A version-aware repository manifest for checking out the OpenAMRobot ecosystem together.

OpenAMRobot logo
-!!! 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. +[`openamrobot-manifest`](https://github.com/openAMRobot/openamrobot-manifest) owns the `.repos` manifest used by `vcs import`. -## What this page should contain +```bash +mkdir -p ~/oamr_ws && cd ~/oamr_ws +vcs import . < /path/to/openamrobot.repos +colcon build +``` -- **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 | -| --- | --- | -| 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 - -- [openamrobot-manifest](https://github.com/openAMRobot/openamrobot-manifest) – canonical source, versions, implementation and issue history. - -## 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. +ROS 2 packages land under `src/` and participate in the colcon build. Hardware, firmware, UI and documentation are checked out beside them and retain their own toolchains. Pin the manifest revision when reproducing a release or test result. diff --git a/docs/reference/openamrobot-release/overview.md b/docs/reference/openamrobot-release/overview.md index 9a3b72e..4214821 100644 --- a/docs/reference/openamrobot-release/overview.md +++ b/docs/reference/openamrobot-release/overview.md @@ -1,48 +1,17 @@ --- -title: Overview +title: openamrobot-release overview --- -
Under development

Overview

Provide the learning-layer reference for overview and point to its owning repository.

OpenAMRobot logo
+
Released · v0.0.1

Frozen product-level source snapshot

A versioned archive of the hardware, software, firmware, UI, interfaces, communication, documentation and governance repositories.

OpenAMRobot logo
-!!! 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. +[`openamrobot-release`](https://github.com/openAMRobot/openamrobot-release) exists because GitHub's automatic archive for one repository cannot represent the multi-repository platform. -## What this page should contain - -- **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 | +| Verify before use | Purpose | | --- | --- | -| 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 - -- [openamrobot-release](https://github.com/openAMRobot/openamrobot-release) – canonical source, versions, implementation and issue history. - -## Contribution note +| `RELEASE_NOTES.md` | Included capability and release context | +| `KNOWN_LIMITATIONS.md` | Unsupported or incomplete behaviour | +| `VERSION` | Product-level version identity | +| `MANIFEST.json` | Participating repositories and source revisions | +| `checksums.sha256` | Archive integrity | -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. +The current public snapshot is [`OpenAMRobot-v0.0.1-source.zip`](https://github.com/openAMRobot/openamrobot-release/releases/tag/v0.0.1). Live repositories may be newer; use the release archive when reproducibility matters. diff --git a/docs/reference/openamrobot-ui/overview.md b/docs/reference/openamrobot-ui/overview.md index d030dcf..1620654 100644 --- a/docs/reference/openamrobot-ui/overview.md +++ b/docs/reference/openamrobot-ui/overview.md @@ -1,48 +1,20 @@ --- -title: Overview +title: openamrobot-ui overview --- -
Under development

Overview

Provide the learning-layer reference for overview and point to its owning repository.

OpenAMRobot logo
+
Active

Browser robot interface

Mapping, driving, Nav2 goals, cameras, routes, missions, Blockly, diagnostics and recordings without ROS tooling in the browser.

OpenAMRobot logo
-!!! 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. +[`openamrobot-ui`](https://github.com/openAMRobot/openamrobot-ui) is the active user-interface repository. Demo Mode runs the interface from browser-side sample data, so contributors can explore it without a robot or ROS connection. -## What this page should contain - -- **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 | +| Area | Available capability | | --- | --- | -| 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 - -- [openamrobot-ui](https://github.com/openAMRobot/openamrobot-ui) – canonical source, versions, implementation and issue history. +| Map and drive | Live map, pose, goal selection, joystick, docking and waypoints | +| Routes and missions | Reusable routes, schedules and multi-step missions | +| Visual programming | Blockly workflows and optional voice-command integration | +| Observation | Camera streams, telemetry, battery, URDF and joint state | +| Health and history | Topic freshness, lifecycle, diagnostics, events and rosbag replay | -## Contribution note +The documented quickstart uses Docker Compose and opens the interface at `127.0.0.1:5050`. Real robot or simulation operation starts the ROS 2 stack separately, then launches the UI workspace against it. -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 "The dashboard stop is not an E-stop" + The red UI control sends a zero-velocity command and requests goal cancellation. It is not latched, safety-rated or independent of the browser and network. Physical hardware requires a tested physical emergency stop. diff --git a/docs/safety/index.md b/docs/safety/index.md index 3483a4f..b5a8e76 100644 --- a/docs/safety/index.md +++ b/docs/safety/index.md @@ -1,3 +1,7 @@ +--- +title: Safety +--- + # Safety OpenAMRobot combines moving machinery, electrical power, batteries, embedded firmware, networks and autonomous software. Public source availability is not a declaration of safety, regulatory compliance or fitness for a particular deployment. diff --git a/docs/solutions/index.md b/docs/solutions/index.md index b5cfbaf..1349d40 100644 --- a/docs/solutions/index.md +++ b/docs/solutions/index.md @@ -1,3 +1,7 @@ +--- +title: Solutions +--- +
Solutions

Start with the work, not the robot

Use one shared platform and reusable capability patterns to address concrete operational problems.

Plan a pilotBuild a local offer
OpenAMRobot logo
## Priority solution families diff --git a/docs/start-here/index.md b/docs/start-here/index.md index dd98505..7c644a1 100644 --- a/docs/start-here/index.md +++ b/docs/start-here/index.md @@ -1,4 +1,5 @@ --- +title: Start here hide: - navigation --- diff --git a/docs/stylesheets/brand.css b/docs/stylesheets/brand.css index 3f1d765..7efbe39 100644 --- a/docs/stylesheets/brand.css +++ b/docs/stylesheets/brand.css @@ -48,16 +48,38 @@ body { color: inherit; } -.md-typeset table:not([class]) { +.md-typeset__table { + display: block; width: 100%; + margin: 1rem 0 1.5rem; + overflow-x: auto; border: 1px solid var(--oamr-border); border-radius: var(--oamr-radius); - box-shadow: none; + background: var(--botshare-white); } -.md-typeset__table { - display: block; +.md-typeset .md-typeset__table table:not([class]) { + display: table; width: 100%; + min-width: 36rem; + margin: 0; + border: 0; + border-collapse: collapse; + table-layout: auto; + box-shadow: none; +} + +.md-typeset table:not([class]) th, +.md-typeset table:not([class]) td { + padding: .75rem 1rem; + border-bottom: 1px solid var(--oamr-border); + vertical-align: top; +} + +.md-typeset table:not([class]) th:first-child, +.md-typeset table:not([class]) td:first-child { + width: 24%; + min-width: 9rem; } .md-typeset table:not([class]) th { @@ -69,6 +91,15 @@ body { background: rgba(0, 114, 198, .035); } +.md-typeset table:not([class]) tr:last-child td { + border-bottom: 0; +} + +[data-md-color-scheme="slate"] .md-typeset__table { + border-color: rgba(255, 255, 255, .13); + background: rgba(255, 255, 255, .03); +} + .md-typeset .admonition, .md-typeset details { border-radius: var(--oamr-radius); @@ -296,15 +327,15 @@ h6, } .oamr-breadcrumbs { - margin: 0 0 1rem; + margin: 0 0 .7rem; color: var(--oamr-muted); - font-size: .78rem; + font-size: .72rem; } .md-typeset .oamr-breadcrumbs ol { display: flex; flex-wrap: nowrap; - gap: .25rem; + gap: .35rem; align-items: center; margin: 0; padding: 0; @@ -320,10 +351,10 @@ h6, } .oamr-breadcrumbs li:not(:last-child)::after { - margin-left: .25rem; - color: var(--botshare-orange); - content: "/"; - font-weight: 800; + margin-left: .35rem; + color: var(--botshare-gray); + content: "›"; + font-weight: 400; } .oamr-breadcrumbs a { @@ -332,7 +363,7 @@ h6, .oamr-breadcrumbs [aria-current="page"] { color: var(--oamr-ink); - font-weight: 700; + font-weight: 600; } [data-md-color-scheme="slate"] .oamr-breadcrumbs [aria-current="page"] { diff --git a/docs/troubleshooting/index.md b/docs/troubleshooting/index.md index 84db21b..fd6600e 100644 --- a/docs/troubleshooting/index.md +++ b/docs/troubleshooting/index.md @@ -1,3 +1,7 @@ +--- +title: Troubleshooting +--- + # Troubleshooting Start with the owning repository’s README and issue tracker because commands, dependencies and known defects are version-specific. diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 95198cc..0db7050 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -1,3 +1,7 @@ +--- +title: Tutorials +--- + # Tutorials Tutorials explain concepts and complete learning paths. Version-sensitive commands remain in their owning repositories and are linked rather than copied here. diff --git a/docs/ui/index.md b/docs/ui/index.md index bbc8625..f591d9e 100644 --- a/docs/ui/index.md +++ b/docs/ui/index.md @@ -1,4 +1,8 @@ -# Operator interface +--- +title: Robot interface +--- + +# Robot interface [openamrobot-ui](https://github.com/openAMRobot/openamrobot-ui) is the active browser-based operator interface for OpenAMRobot. diff --git a/docs/use/blockly/index.md b/docs/use/blockly/index.md index ee6002a..8145d1f 100644 --- a/docs/use/blockly/index.md +++ b/docs/use/blockly/index.md @@ -2,12 +2,12 @@ title: Blockly --- -
Under development

Blockly

Guide an operator through blockly using task language.

OpenAMRobot logo
+
Under development

Blockly

Complete blockly through a clear, task-oriented workflow.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Blockly - **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 | diff --git a/docs/use/demonstration/index.md b/docs/use/demonstration/index.md index e3d30d3..8adfe42 100644 --- a/docs/use/demonstration/index.md +++ b/docs/use/demonstration/index.md @@ -1,48 +1,20 @@ --- -title: Demonstration +title: Teaching by demonstration --- -
Under development

Demonstration

Guide an operator through demonstration using task language.

OpenAMRobot logo
+
Developing workflow

Show, review, correct and judge

Turn a Domain Expert's task knowledge into structured demonstrations and explicit outcome criteria.

OpenAMRobot logo
-!!! 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. +## Workflow -## What this page should contain +
Plan→Capture→Review→Replay→Correct→Evaluate
-- **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. +| Step | Question answered | Continue with | +| --- | --- | --- | +| Plan | What task, starting state, boundaries and success criteria are valid? | [Planning a demonstration](planning-a-demonstration.md) | +| Capture | Which observations, actions and robot state belong in the episode? | [Capturing](capturing.md) | +| Review | Is the episode complete, synchronized and representative? | [Reviewing episodes](reviewing-episodes.md) | +| Replay | Can the recorded trajectory be reproduced within the safe envelope? | [Replaying](replaying.md) | +| Evaluate | Does execution meet task-specific acceptance criteria? | [Evaluating](evaluating.md) | -## Content template - -| 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. - -## Owning OpenAMRobot source - -- [openamrobot-ui](https://github.com/openAMRobot/openamrobot-ui) – canonical source, versions, implementation and issue history. - -## 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. +!!! info "Capability honesty" + This is the intended bounded workflow. It does not claim that the current public release can learn arbitrary tasks. Manipulation, dataset and policy pipelines are still developing and must identify the exact supported configuration. diff --git a/docs/use/driving/index.md b/docs/use/driving/index.md index 3cd691b..04d51d4 100644 --- a/docs/use/driving/index.md +++ b/docs/use/driving/index.md @@ -2,12 +2,12 @@ title: Driving --- -
Under development

Driving

Guide an operator through driving using task language.

OpenAMRobot logo
+
Under development

Driving

Complete driving through a clear, task-oriented workflow.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Driving - **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 | diff --git a/docs/use/index.md b/docs/use/index.md index bb61cd9..c9cde18 100644 --- a/docs/use/index.md +++ b/docs/use/index.md @@ -2,47 +2,23 @@ title: Use --- -
Under development

Use

Guide an operator through use using task language.

OpenAMRobot logo
+
Experimental operation

Operate supported workflows safely

Move from controlled driving and maps to locations, missions, no-code programs, demonstrations and daily monitoring.

OpenAMRobot logo
-!!! 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. +## Operating areas -## What this page should contain +| Area | Use it to | Continue with | +| --- | --- | --- | +| Driving | Establish manual control and safe stop behaviour | [Driving](driving/index.md) | +| Mapping | Create and maintain the robot's spatial reference | [Mapping your space](mapping/index.md) | +| Locations | Name reusable destinations and poses | [Locations and poses](locations/index.md) | +| Missions | Combine supported steps with failure policies and run history | [Missions](missions/index.md) | +| Blockly | Build bounded workflows without writing ROS 2 code | [Programming without code](blockly/index.md) | +| Demonstration | Capture, review and evaluate task demonstrations | [Teaching by demonstration](demonstration/index.md) | +| Monitoring | Read robot state, logs and events during daily operation | [Monitoring](monitoring/index.md) | -- **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. +
Inspect→Start→Run→Monitor→Recover or stop→Record
-## Content template +The browser interface lives in [`openamrobot-ui`](https://github.com/openAMRobot/openamrobot-ui). ROS 2 navigation and docking behaviour lives in [`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. - -## Owning OpenAMRobot source - -- [openamrobot-ui](https://github.com/openAMRobot/openamrobot-ui) – canonical source, versions, implementation and issue history. - -## 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 "Know the supported boundary" + Verify release, robot profile, environment and safety assumptions before operation. A simulation result is not evidence that a physical deployment is safe or accepted. diff --git a/docs/use/locations/index.md b/docs/use/locations/index.md index 9d79ce7..abb6557 100644 --- a/docs/use/locations/index.md +++ b/docs/use/locations/index.md @@ -2,12 +2,12 @@ title: Locations --- -
Under development

Locations

Guide an operator through locations using task language.

OpenAMRobot logo
+
Under development

Locations

Complete locations through a clear, task-oriented workflow.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Locations - **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 | diff --git a/docs/use/mapping/index.md b/docs/use/mapping/index.md index 0b1ded5..09f7ad9 100644 --- a/docs/use/mapping/index.md +++ b/docs/use/mapping/index.md @@ -2,12 +2,12 @@ title: Mapping --- -
Under development

Mapping

Guide an operator through mapping using task language.

OpenAMRobot logo
+
Under development

Mapping

Complete mapping through a clear, task-oriented workflow.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Mapping - **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 | diff --git a/docs/use/missions/index.md b/docs/use/missions/index.md index 154b90e..8554d26 100644 --- a/docs/use/missions/index.md +++ b/docs/use/missions/index.md @@ -2,12 +2,12 @@ title: Missions --- -
Under development

Missions

Guide an operator through missions using task language.

OpenAMRobot logo
+
Under development

Missions

Complete missions through a clear, task-oriented workflow.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Missions - **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 | diff --git a/docs/use/monitoring/index.md b/docs/use/monitoring/index.md index 1f0f2a9..17ded93 100644 --- a/docs/use/monitoring/index.md +++ b/docs/use/monitoring/index.md @@ -2,12 +2,12 @@ title: Monitoring --- -
Under development

Monitoring

Guide an operator through monitoring using task language.

OpenAMRobot logo
+
Under development

Monitoring

Complete monitoring through a clear, task-oriented workflow.

OpenAMRobot logo
!!! 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. @@ -16,11 +16,11 @@ title: Monitoring - **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 |