Integrate repositories documentation into the documentation website - #1
Conversation
bcastets-robotiq
commented
Jul 2, 2026
- 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.
- 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>
|
Added three commits to this branch While reviewing, I pushed a few changes on top of the existing work:
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 |
|
autres commentaires mineurs de claude: |
|
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)