Registering a Robot
Three ways to add your robot to the global registry.
Method 1: GitHub Issue (Recommended)
The simplest method - no coding required.
- Go to the Submit page
- Click "Submit via GitHub Issue"
- Fill in the form fields:
- Robot name and manufacturer
- Model identifier
- Description
- Technical specifications (optional)
- Links to URDF, GitHub, website
- Submit the issue
- Wait for maintainer review (24-48 hours)
Tip: Include as much detail as possible. Complete registrations are processed faster.
Method 2: Auto-Register from RURI
If your robot supports the RCAN protocol and serves a manifest:
- Go to Auto-Register
- Enter your robot's RURI
- The system fetches the manifest automatically
- Review the data
- Click to create a GitHub issue
Manifest Requirements
Your robot must serve a JSON manifest at:
https://<registry>/.well-known/rcan-manifest.json Minimum required fields:
{
"ruri": "rcan://example.com/acme/bot-x1/12345678",
"name": "Robot Name",
"manufacturer": "Manufacturer",
"model": "model-id"
} Method 3: Pull Request
For developers comfortable with Git:
- Fork the rcan-spec repository
- Create a new file:
src/content/robots/RRN-XXXXXXXX.yaml - Use the YAML schema
- Optionally add an image to
public/robots/ - Submit a pull request
Note: Leave the RRN as a placeholder. Maintainers will assign the next available number.
What Happens After Registration?
- Review - Maintainers verify the data
- RRN Assignment - Your robot gets a unique number
- Publication - Robot appears in the registry
- Resources - Badge, QR code, and API access become available
Registration Requirements
| Field | Required | Notes |
|---|---|---|
| Name | Yes | Human-readable robot name |
| Manufacturer | Yes | Company or organization |
| Model | Yes | Unique model identifier |
| Description | Yes | Brief description of the robot |
| Status | Yes | active, retired, prototype, or concept |
| Image | No | SVG preferred, PNG/JPG accepted |
| Specs | No | Technical specifications |
| Links | No | URDF, GitHub, website URLs |