Skip to content

Commit dd5a2a7

Browse files
Connector Framework documentation and CI workflow (#1)
* feat: add Connector Framework documentation and CI workflow - Updated docs.json to include a new "Connector Framework" section with detailed pages on usage, configuration, and specifications. - Introduced a GitHub Actions workflow for syncing Connector Framework documentation from the inorbit-connector-python repository. - Modified connectors.mdx to link to the new Connector Framework documentation, enhancing accessibility for users. * Fix broken links by adding placeholder pages * Use a temporary branch * Test trigger * Sync connector framework docs from inorbit-connector-python * Revert "Sync connector framework docs from inorbit-connector-python" This reverts commit e14333d. * Revert "Test trigger" This reverts commit e6e8657. * Revert "Use a temporary branch" This reverts commit 1d04f04. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 73fb3db commit dd5a2a7

17 files changed

Lines changed: 163 additions & 2 deletions

File tree

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Sync Connector Framework Docs
2+
3+
on:
4+
# Manual trigger
5+
workflow_dispatch:
6+
# Nightly sync
7+
schedule:
8+
- cron: "17 3 * * *"
9+
10+
permissions:
11+
contents: write
12+
13+
jobs:
14+
sync:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout docs repo
18+
uses: actions/checkout@v4
19+
with:
20+
path: docs-repo
21+
22+
- name: Checkout connector repo
23+
uses: actions/checkout@v4
24+
with:
25+
repository: inorbit-ai/inorbit-connector-python
26+
ref: main
27+
path: connector-repo
28+
29+
- name: Set up Python
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: "3.13"
33+
34+
- name: Build Mintlify-compatible docs
35+
run: |
36+
cd connector-repo/docs/mintlify
37+
make build
38+
39+
- name: Sync to docs repo
40+
run: |
41+
# Remove old connector framework docs
42+
rm -rf docs-repo/ground-control/robot-integration/connector-framework
43+
44+
# Copy built docs
45+
mkdir -p docs-repo/ground-control/robot-integration/connector-framework
46+
cp -r connector-repo/docs/mintlify/_build/* docs-repo/ground-control/robot-integration/connector-framework/
47+
48+
- name: Commit and push
49+
run: |
50+
cd docs-repo
51+
git config user.name "github-actions[bot]"
52+
git config user.email "github-actions[bot]@users.noreply.github.com"
53+
54+
git add -A
55+
if git diff --staged --quiet; then
56+
echo "No changes to commit"
57+
else
58+
git commit -m "Sync connector framework docs from inorbit-connector-python"
59+
git push
60+
fi

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
"ground-control/robot-integration/overview",
7979
"ground-control/robot-integration/agent",
8080
"ground-control/robot-integration/connectors",
81+
"ground-control/robot-integration/connector-framework/index",
8182
"ground-control/robot-integration/robot-sdk",
8283
"ground-control/robot-integration/edge-sdk",
8384
"ground-control/robot-integration/interoperability"
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Configuration"
3+
description: "Configuration models and file formats for connectors"
4+
---
5+
6+
Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python).
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Getting Started"
3+
description: "Installation and setup for the InOrbit Connector Framework"
4+
---
5+
6+
Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python).
7+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: "Connector Framework"
3+
description: "Python framework for developing InOrbit robot connectors"
4+
---
5+
6+
This page will be automatically populated by the [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python) repository.
7+
8+
See the [GitHub repository](https://github.com/inorbit-ai/inorbit-connector-python) for the latest documentation.
9+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Publishing Data"
3+
description: "How to publish robot data to InOrbit"
4+
---
5+
6+
Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python).
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Commands Utilities"
3+
description: "Command handling utilities specification"
4+
---
5+
6+
Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python).
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Connector API"
3+
description: "Connector and FleetConnector class specifications"
4+
---
5+
6+
Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python).
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Specification"
3+
description: "Public API specification for the inorbit-connector package"
4+
---
5+
6+
Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python).
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Logging"
3+
description: "Logging configuration specification"
4+
---
5+
6+
Content synced from [inorbit-connector-python](https://github.com/inorbit-ai/inorbit-connector-python).
7+

0 commit comments

Comments
 (0)