diff --git a/.github/workflows/multirepo-connector-framework.yml b/.github/workflows/multirepo-connector-framework.yml new file mode 100644 index 0000000..f9f2f86 --- /dev/null +++ b/.github/workflows/multirepo-connector-framework.yml @@ -0,0 +1,60 @@ +name: Sync Connector Framework Docs + +on: + # Manual trigger + workflow_dispatch: + # Nightly sync + schedule: + - cron: "17 3 * * *" + +permissions: + contents: write + +jobs: + sync: + runs-on: ubuntu-latest + steps: + - name: Checkout docs repo + uses: actions/checkout@v4 + with: + path: docs-repo + + - name: Checkout connector repo + uses: actions/checkout@v4 + with: + repository: inorbit-ai/inorbit-connector-python + ref: main + path: connector-repo + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.13" + + - name: Build Mintlify-compatible docs + run: | + cd connector-repo/docs/mintlify + make build + + - name: Sync to docs repo + run: | + # Remove old connector framework docs + rm -rf docs-repo/ground-control/robot-integration/connector-framework + + # Copy built docs + mkdir -p docs-repo/ground-control/robot-integration/connector-framework + cp -r connector-repo/docs/mintlify/_build/* docs-repo/ground-control/robot-integration/connector-framework/ + + - name: Commit and push + run: | + cd docs-repo + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + + git add -A + if git diff --staged --quiet; then + echo "No changes to commit" + else + git commit -m "Sync connector framework docs from inorbit-connector-python" + git push + fi diff --git a/docs.json b/docs.json index 8e8bdeb..f6f5940 100644 --- a/docs.json +++ b/docs.json @@ -78,6 +78,7 @@ "ground-control/robot-integration/overview", "ground-control/robot-integration/agent", "ground-control/robot-integration/connectors", + "ground-control/robot-integration/connector-framework/index", "ground-control/robot-integration/robot-sdk", "ground-control/robot-integration/edge-sdk", "ground-control/robot-integration/interoperability" diff --git a/ground-control/robot-integration/connector-framework/configuration.md b/ground-control/robot-integration/connector-framework/configuration.md new file mode 100644 index 0000000..50ddfa8 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/configuration.md @@ -0,0 +1,7 @@ +--- +title: "Configuration" +description: "Configuration models and file formats for connectors" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/getting-started.md b/ground-control/robot-integration/connector-framework/getting-started.md new file mode 100644 index 0000000..47b5fd0 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/getting-started.md @@ -0,0 +1,7 @@ +--- +title: "Getting Started" +description: "Installation and setup for the InOrbit Connector Framework" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/index.md b/ground-control/robot-integration/connector-framework/index.md new file mode 100644 index 0000000..53b7711 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/index.md @@ -0,0 +1,9 @@ +--- +title: "Connector Framework" +description: "Python framework for developing InOrbit robot connectors" +--- + +This page will be automatically populated by the [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python) repository. + +See the [GitHub repository](https://github.com/inorbit-ai/inorbit-connector-python) for the latest documentation. + diff --git a/ground-control/robot-integration/connector-framework/publishing.md b/ground-control/robot-integration/connector-framework/publishing.md new file mode 100644 index 0000000..ca99305 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/publishing.md @@ -0,0 +1,7 @@ +--- +title: "Publishing Data" +description: "How to publish robot data to InOrbit" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/specification/commands.md b/ground-control/robot-integration/connector-framework/specification/commands.md new file mode 100644 index 0000000..7da2d56 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/specification/commands.md @@ -0,0 +1,7 @@ +--- +title: "Commands Utilities" +description: "Command handling utilities specification" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/specification/connector.md b/ground-control/robot-integration/connector-framework/specification/connector.md new file mode 100644 index 0000000..5698eab --- /dev/null +++ b/ground-control/robot-integration/connector-framework/specification/connector.md @@ -0,0 +1,7 @@ +--- +title: "Connector API" +description: "Connector and FleetConnector class specifications" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/specification/index.md b/ground-control/robot-integration/connector-framework/specification/index.md new file mode 100644 index 0000000..3562ad6 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/specification/index.md @@ -0,0 +1,7 @@ +--- +title: "Specification" +description: "Public API specification for the inorbit-connector package" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/specification/logging.md b/ground-control/robot-integration/connector-framework/specification/logging.md new file mode 100644 index 0000000..1ca6d9e --- /dev/null +++ b/ground-control/robot-integration/connector-framework/specification/logging.md @@ -0,0 +1,7 @@ +--- +title: "Logging" +description: "Logging configuration specification" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/specification/models.md b/ground-control/robot-integration/connector-framework/specification/models.md new file mode 100644 index 0000000..21dee7e --- /dev/null +++ b/ground-control/robot-integration/connector-framework/specification/models.md @@ -0,0 +1,7 @@ +--- +title: "Models" +description: "Configuration models specification" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/specification/utils.md b/ground-control/robot-integration/connector-framework/specification/utils.md new file mode 100644 index 0000000..18877bc --- /dev/null +++ b/ground-control/robot-integration/connector-framework/specification/utils.md @@ -0,0 +1,7 @@ +--- +title: "Utilities" +description: "Utility functions specification" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/usage/commands-handling.md b/ground-control/robot-integration/connector-framework/usage/commands-handling.md new file mode 100644 index 0000000..f0e85cd --- /dev/null +++ b/ground-control/robot-integration/connector-framework/usage/commands-handling.md @@ -0,0 +1,7 @@ +--- +title: "Commands Handling" +description: "How to handle commands from InOrbit" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/usage/fleet.md b/ground-control/robot-integration/connector-framework/usage/fleet.md new file mode 100644 index 0000000..dce0c20 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/usage/fleet.md @@ -0,0 +1,7 @@ +--- +title: "Fleet Connector" +description: "Guide for implementing a fleet connector" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/usage/index.md b/ground-control/robot-integration/connector-framework/usage/index.md new file mode 100644 index 0000000..629e190 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/usage/index.md @@ -0,0 +1,7 @@ +--- +title: "Usage" +description: "Guides for implementing connectors" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connector-framework/usage/single-robot.md b/ground-control/robot-integration/connector-framework/usage/single-robot.md new file mode 100644 index 0000000..3bc4cf4 --- /dev/null +++ b/ground-control/robot-integration/connector-framework/usage/single-robot.md @@ -0,0 +1,7 @@ +--- +title: "Single-Robot Connector" +description: "Guide for implementing a single-robot connector" +--- + +Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python). + diff --git a/ground-control/robot-integration/connectors.mdx b/ground-control/robot-integration/connectors.mdx index f0f1fe8..dd412c5 100644 --- a/ground-control/robot-integration/connectors.mdx +++ b/ground-control/robot-integration/connectors.mdx @@ -108,8 +108,8 @@ class MyConnector(InOrbitConnector): pass ``` - - View documentation and examples on GitHub + + Learn how to build your own connectors with the Python framework (API spec, configuration, and examples) ## Connector Configuration