Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: CI

# Verifies the documentation site builds and passes basic smoke tests.
# Intended to be a required status check for merging into main.

on:
pull_request:
branches:
- main
push:
branches:
- main
workflow_dispatch:

permissions:
contents: read

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
build-and-test:
runs-on: ubuntu-latest
steps:
# Submodules aren't checked out here — scripts/sync-external-docs.js
# runs `git submodule update --init --force` itself as part of the
# build (needed for local `npm start`/`npm run build` too), so doing
# it again via actions/checkout would just be a redundant second fetch.
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci

# Fails on broken internal links / anchors (onBrokenLinks: 'throw')
# and runs the sync + tools-table generators via the prebuild hook.
- name: Build
run: npm run build

# Smoke-tests the generated output (key pages + tools table present).
- name: Test
run: npm test
6 changes: 4 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
# Submodules aren't checked out here — scripts/sync-external-docs.js
# runs `git submodule update --init --force` itself as part of the
# build, so doing it again via actions/checkout would just be a
# redundant second fetch.
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: actions/setup-node@v4
with:
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
# Generated files
.docusaurus
.cache-loader
docs/drivers/TSF-85/SDK/C++/_readme.md
docs/drivers/TSF-85/SDK/Python/_readme.md

# Editor / machine-specific
.vscode/

# Misc
.DS_Store
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "external/tactile_sensors"]
path = external/tactile_sensors
url = https://github.com/Robotiq/tactile_sensors
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
This repository contains general documentation about Robotiq software tools for
developers.
The documentation is rendered into a static documentation website
accessible at the followng URL:
accessible at the followng URL:
https://robotiq.github.io/

Loading
Loading