Documentation / Developer Guide

PhyAgentOS Developer Guide

This document is intended for core developers, covering contribution workflows and project roadmaps. Whether you plan to develop plugins or integrate new robots, you will find the relevant guidance here. The document also includes the development roadmap β€” contributors are welcome to choose features of interest or propose new ones.

Quick Start

Development directions fall into three categories: for new plugin development, refer to the ReKep example; for new hardware integration, refer to the Driver integration flow; for submitting PRs, please read the contribution workflow and roadmap first.

πŸ”Œ

ReKep Plugin Example

Complete plugin development guide from manifest to runtime layering
πŸ€–

New Driver Integration

BaseDriver interface, profiles, and full Watchdog verification flow
πŸ“

Code Style Conventions

Naming, directory boundaries, Ruff config, minimum quality standards
πŸ—ΊοΈ

Roadmap

Completed, in-progress, and to-be-developed topics and hardware list
🀝

Contribution Workflow

Fork, branch naming, pre-commit checks, PR template, review standards

Choose Your Starting Point by Background

Your BackgroundRecommended Reading Order
New to the project, looking to get started quicklyArchitecture β†’ Plugin Usage
Planning to write a driver for a new robotDriver Integration β†’ Code Style
Planning to develop an external plugin rather than modifying the main repoReKep Example β†’ Contribution Workflow
Undecided on direction, looking to explore open itemsRoadmap
If you encounter any issues, GitHub Issues are the recommended channel for support. Please search for existing issues before creating a new one.