Skip to content

Integrate repositories documentation into the documentation website - #1

Merged
bcastets-robotiq merged 8 commits into
mainfrom
Repository-documentation-retrieval
Jul 8, 2026
Merged

Integrate repositories documentation into the documentation website#1
bcastets-robotiq merged 8 commits into
mainfrom
Repository-documentation-retrieval

Conversation

@bcastets-robotiq

Copy link
Copy Markdown
Collaborator
  • I updated the documentation website to retrieve documentation of all repositories.
  • A table is automatically generated to sumup the software tools available for each product
  • A contribute file have been written to explain the documentation procedure
  • The example section have been removed because it is empty.

bcastets-robotiq and others added 7 commits July 2, 2026 21:05
- Automatic summary table of drivers (import readme and docs when available)
- contribution file describing the documentation process
I added some code to be able to mention the URL of the documentation website in all readme without having it imported on the documentation website.
I add GrasGen for 2F
This PR removes docs/drivers.mdx, but the footer "Drivers" link still
pointed at /docs/drivers. Docusaurus treats broken links as fatal, so
`docusaurus build` (and the deploy workflow) failed on every page.
Repoint the link to /docs/intro, the docs entry point that now hosts
the auto-generated tools table.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
One-command wrapper around the local workflow documented in
docs/contribute.mdx: syncs submodules, installs deps if missing, and
starts the Docusaurus dev server. Usage: ./preview.sh [port].

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Adds a `test` script (scripts/check-build.js) that sanity-checks the
production build: key pages are emitted and the auto-generated tools
table was injected into the intro page. Combined with Docusaurus's
onBrokenLinks: 'throw', this catches broken links and empty generated
sections.

Adds .github/workflows/ci.yml, which runs `npm ci`, `npm run build`,
and `npm test` on every pull request to main. Mark this check as
required in the branch protection settings for main to gate merges.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mbegin-robotiq

Copy link
Copy Markdown
Contributor

Added three commits to this branch

While reviewing, I pushed a few changes on top of the existing work:

  • 3f564d5 — Fix broken footer link to removed /docs/drivers page
    The footer "Drivers" link still pointed at /docs/drivers, which this PR deletes. With onBrokenLinks: 'throw', that made docusaurus build (and the deploy workflow) fail on every page. Repointed it to /docs/intro, the docs entry point that now hosts the generated tools table. This is what was blocking the production build.

  • ae30f4c — Add preview.sh
    One-command wrapper around the local workflow documented in docs/contribute.mdx: syncs submodules, installs deps if missing, and starts the dev server. Usage: ./preview.sh [port].

  • 81f91a5 — Add CI pipeline (.github/workflows/ci.yml)
    Runs npm cinpm run buildnpm test on every PR to main. The build step fails on broken links/anchors; the new npm test (scripts/check-build.js) smoke-tests the output (key pages present + tools table injected into the intro page). Intended to be a required status check for merging. Verified it fails without the footer fix above and passes with it.

The remaining items I found are posted as separate review comments above rather than changed here, since they warrant a decision (taxonomy grouping, generated-file/gitignore cleanup, orphan pages, the /docs/hardware HTML warning, GraspGen spelling, clickable-vs-static homepage cards, and gating broken anchors).

@mbegin-robotiq
mbegin-robotiq self-requested a review July 2, 2026 18:26
Comment thread scripts/generate-tools-table.js Outdated
Comment thread .gitignore Outdated
Comment thread docs/drivers/2F hande/GraspGen/index.mdx Outdated
Comment thread docusaurus.config.js
Comment thread src/pages/index.js
Comment thread docusaurus.config.js
@ebarnett3

Copy link
Copy Markdown

autres commentaires mineurs de claude:

## Plausible (real mechanism, needs a future input to trigger)

5. **`scripts/sync-external-docs.js:111`** — single-file sync jobs rewrite relative image links to GitHub `blob/` URLs, which serve HTML, not image bytes. No current synced README has images, but the first upstream README that adds one renders broken; use `raw.githubusercontent.com`.

6. **`scripts/generate-tools-table.js:66`** — `docHref` only escapes spaces; a future folder containing `#`, `?`, or `%` emits a corrupt link and fails the whole build via `onBrokenLinks: 'throw'` (the `C++` handling itself is correct).

7. **`scripts/generate-tools-table.js:42`** — hand-rolled frontmatter regex keeps quotes and mishandles colons in titles (`title: "Foo: bar"` → wrong column key). All current titles parse fine; gray-matter is already in the lock file transitively and would make this robust.

8. **`scripts/sync-external-docs.js:84`** — the leading-H1 strip regex anchors at byte 0, so a README starting with a badge or blank line before its `# Title` keeps the H1 → duplicate heading on the page.

## Minor

- CI checks out submodules twice (`submodules: true` in checkout + the script's `git submodule update --init --force`).
- `fetch-depth: 0` in ci.yml is unnecessary (build never uses history).
- `prestart`/`prebuild` are copy-pasted identical strings; factor into one script.
- Each tool `index.mdx` is read from disk twice per table generation (`readFrontmatterTitle` + `readCompactBadge`).

Comment thread .vscode/settings.json Outdated
Comment thread scripts/sync-external-docs.js Outdated
Comment thread package.json Outdated
@bcastets-robotiq

Copy link
Copy Markdown
Collaborator Author

Merci pour la revue du code. C'est la première fois que je passe au travers de ce process de PR, ca va peut etre me prendre du temps de comprendre comment le compléter. Je me lance !

@ebarnett3

Copy link
Copy Markdown

Merci pour la revue du code. C'est la première fois que je passe au travers de ce process de PR, ca va peut etre me prendre du temps de comprendre comment le compléter. Je me lance !

Généralement, si t'es d'accord avec les revues tu peux déléguer les changements à claude. Il peut aider pour répondre quand t'es pas d'accord aussi!

- Split each product's tool pages into SDK/ROS/Physics Engine/Other
  subfolders, classified by a `Category` badge rather than folder
  depth, and migrate TSF-85 and FT300 to match the 2F hande layout
- Replace the single tools-overview table with one table per
  category, plus ROS1/ROS2 compatibility tables showing per-distro
  support via paired `Distro`/`Supported_by` badges
- Update sidebars.js to nest tool pages under the new categories
- Move orphaned examples.mdx/hardware.mdx into a new draft/ folder
  (outside docs/) so they stop building as unlinked pages
- Address review feedback: fix stale .gitignore entries, drop the
  unused org-profile/ros submodules and dead `deploy` script, escape
  special characters in generated links, sync README images via
  raw.githubusercontent.com, parse frontmatter with gray-matter, fix
  leading-H1 stripping for badge-prefixed READMEs, enable
  onBrokenAnchors, untrack machine-specific .vscode/settings.json
- Rewrite docs/contribute.mdx for the new category/badge/table system
- Remove inert sidebar_position frontmatter (sidebars.js is fully
  manual) and other dead code (duplicate CI submodule checkout,
  prestart/prebuild duplication, double file reads in the table
  generator)
- Remove the hover zoom effect on homepage feature cards (they aren't
  links)
@bcastets-robotiq
bcastets-robotiq merged commit ad3eb92 into main Jul 8, 2026
1 check passed
@bcastets-robotiq
bcastets-robotiq deleted the Repository-documentation-retrieval branch July 8, 2026 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants