AI Coding Support

This document describes how to use AI assistance tools (such as CodeBuddy, Codex, Cursor, etc.) to quickly develop robot extensions.

Preparation

Before using AI coding, you need to prepare reference documentation:

• SDK Documentation: https://dev.sh-agilebot.com/docs/sdk/knowledge/docs.txt
• Extension Development Documentation: https://dev.sh-agilebot.com/docs/extension/knowledge/docs.txt

Tip: If your AI Agent cannot read URLs well, it is recommended to download the above two txt documents to your local project directory, and then reference the local file paths in your prompts.

Example Prompt

Here is a complete example for creating a common service extension that displays robot status:

Read the following documentation and write a common service extension with a frontend page that displays the robot's current position, coordinate system number, servo status, and other information.

Reference materials:
SDK Documentation: https://dev.sh-agilebot.com/docs/sdk/knowledge/docs.txt
Extension Documentation: https://dev.sh-agilebot.com/docs/extension/knowledge/docs.txt

If using local documentation, you can modify it to:

Read the following documentation and write a common service extension with a frontend page that displays the robot's current position, coordinate system number, servo status, and other information.

Reference materials:
SDK Documentation: ./docs/sdk_docs.txt
Extension Documentation: ./docs/extension_docs.txt

Usage Tips

1. Clear Requirements: Clearly describe the functionality you want to implement
2. Provide Context: Reference relevant documentation and examples
3. Stepwise Implementation: Complex features can be generated step by step with AI

Notes

1. Code generated by AI needs to be verified and tested
2. Ensure code complies with project coding standards
3. Code involving robot control must undergo security review