Skip to content

Add bilingual English and French documentation - #5

Merged
thannous merged 2 commits into
mainfrom
codex/publish-bilingual-docs
Jul 31, 2026
Merged

Add bilingual English and French documentation#5
thannous merged 2 commits into
mainfrom
codex/publish-bilingual-docs

Conversation

@thannous

@thannous thannous commented Jul 31, 2026

Copy link
Copy Markdown
Owner

Summary

  • preserve the existing French documentation under explicit .fr.md and docs/fr/ paths
  • provide English counterparts at the canonical documentation paths
  • add an English · Français language switch to every affected document
  • refresh research status and repair relative links after the bilingual split

This pull request contains documentation only: 34 Markdown files, with no source-code or configuration changes.

Validation

  • npm run validate
  • npm run check
  • 99 root tests passed
  • 33 GUI tests passed
  • local links validated across 46 Markdown files
  • production build passed
  • git diff --cached --check passed before commit

Docstring density note

A separate whole-repository AST audit found sparse formal JSDoc (4/95 exported functions, 4.21%), while 52/256 named functions (20.31%) have a leading explanatory comment. No blanket comment churn is included here; a focused follow-up should document exported and complex boundaries.

Summary by CodeRabbit

  • Documentation
    • Introduced full French translations for contributing guides, security policies, installation instructions, and research documentation.
    • Enhanced docs with bilingual navigation supporting both English and French readers.
    • Updated research findings with confirmed hardware observations and measurements.

Copy link
Copy Markdown
Owner Author

@codex review

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@thannous, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 43 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1729bde8-eea0-4ab9-b69c-7bf7b0ad4461

📥 Commits

Reviewing files that changed from the base of the PR and between 58e4122 and cfb4868.

📒 Files selected for processing (15)
  • CONTRIBUTING.fr.md
  • README.md
  • docs/compatibility.md
  • docs/fr/compatibility.md
  • docs/fr/installation.md
  • docs/fr/publishing-checklist.md
  • docs/fr/research/effort-wheel-calibration.md
  • docs/fr/research/thread-status-feasibility.md
  • docs/fr/scope-and-limitations.md
  • docs/installation.md
  • docs/publishing-checklist.md
  • docs/research/thread-status-feasibility.md
  • docs/scope-and-limitations.md
  • profiles/claude-shortcuts/README.md
  • thread-status/README.md
📝 Walkthrough

Walkthrough

The PR adds French versions of project documentation and translates existing French documents into English. It covers contribution, licensing, security, setup, compatibility, research, roadmap, scope, and project vision. Several research and roadmap sections also update measured hardware and session-status findings.

Changes

Documentation du projet

Layer / File(s) Summary
Contribution, licence et sécurité
CONTRIBUTING*.md, LICENSING*.md, SECURITY*.md
Ajoute les guides français et traduit les guides anglais sur les règles de contribution, les licences, la sécurité, les exports, le BLE et la restauration.
Configuration et installation
docs/codex-micro/*, docs/fr/codex-micro/*, docs/getting-started.md, docs/fr/getting-started.md, docs/installation.md, docs/fr/installation.md, docs/compatibility.md, docs/fr/compatibility.md, docs/publishing-checklist.md, docs/fr/publishing-checklist.md
Documente le workflow de configuration et d’installation du profil Claude V1 en français et en anglais.
Recherche matérielle et protocoles
docs/research/*, docs/fr/research/*
Ajoute ou traduit les recherches sur AppSense, la molette, le transport HID, l’éclairage et les flux Input.
État des sessions et périmètre
docs/research/thread-status-feasibility.md, docs/fr/research/thread-status-feasibility.md, docs/roadmap.md, docs/fr/roadmap.md, docs/scope-and-limitations.md, docs/fr/scope-and-limitations.md, docs/vision.md, docs/fr/vision.md
Met à jour les informations sur les sessions Claude, la navigation Claude Desktop, le rendu HID, les contraintes ChatGPT, le périmètre et la feuille de route.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

  • thannous/claude-codex-micro#1: Étend et traduit les mêmes documents de contribution, de publication, de feuille de route, de vision et de sécurité.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding bilingual English and French documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/publish-bilingual-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 58e41228e5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/vision.md

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 10

🧹 Nitpick comments (1)
docs/publishing-checklist.md (1)

38-49: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Clarify the version of the completed compatibility evidence.

The checklists mark the Input 0.17.2 Import/Export evidence as a current Claude V1 gate, while docs/getting-started.md describes the 0.17.2 layer format as historical and the active profile workflow uses Input 0.17.3. Verify the intended status. If 0.17.2 is historical, label the checkbox accordingly or update it to the 0.17.3 evidence.

  • docs/publishing-checklist.md#L38-L49: clarify the 0.17.2 checkbox.
  • docs/fr/publishing-checklist.md#L38-L49: apply the same clarification in French.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/publishing-checklist.md` around lines 38 - 49, The Claude V1
compatibility checklist must identify the evidence version accurately: update
the `0.17.2` Import/Export checkbox in `docs/publishing-checklist.md` to the
active `0.17.3` evidence, or explicitly label `0.17.2` as historical; apply the
same clarification to the corresponding French checkbox in
`docs/fr/publishing-checklist.md`, preserving each document’s language.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.fr.md`:
- Line 142: Update the security-document link in the French contributing guide
to reference SECURITY.fr.md instead of SECURITY.md, preserving the existing
instruction text and language-consistent navigation.

In `@docs/compatibility.md`:
- Line 16: Update the focus-loss validation status in docs/compatibility.md at
line 16 from pending to the measured-and-validated result documented in the
configuration files, then apply the identical English status wording to
docs/fr/compatibility.md at line 16.

In `@docs/fr/installation.md`:
- Around line 241-246: Replace the literal AppSense IDs in the documented
build-input-profile command with explicit placeholders or shell variables
representing the user’s device-specific values, while preserving the command
structure and the French explanation of the repair use case.
- Around line 254-260: Update the guidance around the
`~/Library/Logs/input/main.log` reference to state that the log must remain
local and that users should redact addresses, tokens, and other sensitive
parameters before sharing or inspecting excerpts. Instruct them to copy only the
required AppSense `linkedAppId` values.

In `@docs/fr/research/effort-wheel-calibration.md`:
- Around line 17-18: Correct the French agreement in the `⌘⇧E` toggle
description by changing “vérifié” to “vérifiée” after “bascule,” while
preserving the rest of the sentence.

In `@docs/installation.md`:
- Around line 253-259: Update the installation documentation near the
`~/Library/Logs/input/main.log` guidance to warn that the log may contain
private device data; instruct users to keep it local, never paste it into
issues, and redact identifiers and other sensitive values before sharing.
- Around line 240-251: The installation example exposes stable-looking AppSense
identifiers that readers may copy incorrectly. Replace the literal values in the
build-input-profile command with clearly non-copyable placeholders or variables,
and instruct readers to resolve and verify the corresponding identifiers from
their current device configuration before running it, consistent with the
local-identifier guidance in the surrounding documentation.

In `@docs/research/thread-status-feasibility.md`:
- Around line 84-85: Update the evidence status for the Claude Desktop route in
docs/research/thread-status-feasibility.md:84-85 from “refuted” to an equivalent
of “confirmed on this machine.” Apply the corresponding status correction from
“réfuté” to a confirmed equivalent in
docs/fr/research/thread-status-feasibility.md:84-85; leave the supporting route
and UUID-validation evidence unchanged.
- Around line 7-16: Update the navigation conclusions in
docs/research/thread-status-feasibility.md lines 7-16 to describe terminal
window-focus navigation as implemented but unverified, reserving “solved” for
the verified Claude Desktop route; apply the same distinction in
docs/fr/research/thread-status-feasibility.md lines 7-16 while preserving the
existing bilingual structure.

In `@docs/scope-and-limitations.md`:
- Around line 56-67: Update docs/scope-and-limitations.md (lines 56-67) and
docs/fr/scope-and-limitations.md (lines 55-66) so the “Restore on exit”
condition accurately reflects the implemented behavior: either document only
shutdown/exception paths that actually close or restore lighting, or add the
missing restore handling for interrupts, shutdowns, and uncaught failures before
retaining those claims. Keep both language versions synchronized.

---

Nitpick comments:
In `@docs/publishing-checklist.md`:
- Around line 38-49: The Claude V1 compatibility checklist must identify the
evidence version accurately: update the `0.17.2` Import/Export checkbox in
`docs/publishing-checklist.md` to the active `0.17.3` evidence, or explicitly
label `0.17.2` as historical; apply the same clarification to the corresponding
French checkbox in `docs/fr/publishing-checklist.md`, preserving each document’s
language.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8e3efc01-4a26-43c0-b672-0b625d1dd519

📥 Commits

Reviewing files that changed from the base of the PR and between 3a08d41 and 58e4122.

📒 Files selected for processing (34)
  • CONTRIBUTING.fr.md
  • CONTRIBUTING.md
  • LICENSING.fr.md
  • LICENSING.md
  • SECURITY.fr.md
  • SECURITY.md
  • docs/codex-micro/configuration.md
  • docs/codex-micro/local-observation-2026-07-27.md
  • docs/compatibility.md
  • docs/fr/codex-micro/configuration.md
  • docs/fr/codex-micro/local-observation-2026-07-27.md
  • docs/fr/compatibility.md
  • docs/fr/getting-started.md
  • docs/fr/installation.md
  • docs/fr/publishing-checklist.md
  • docs/fr/research/appsense-behavior.md
  • docs/fr/research/effort-wheel-calibration.md
  • docs/fr/research/hid-lighting-protocol.md
  • docs/fr/research/input-0.17.2-sharing.md
  • docs/fr/research/thread-status-feasibility.md
  • docs/fr/roadmap.md
  • docs/fr/scope-and-limitations.md
  • docs/fr/vision.md
  • docs/getting-started.md
  • docs/installation.md
  • docs/publishing-checklist.md
  • docs/research/appsense-behavior.md
  • docs/research/effort-wheel-calibration.md
  • docs/research/hid-lighting-protocol.md
  • docs/research/input-0.17.2-sharing.md
  • docs/research/thread-status-feasibility.md
  • docs/roadmap.md
  • docs/scope-and-limitations.md
  • docs/vision.md

Comment thread CONTRIBUTING.fr.md Outdated
Comment thread docs/compatibility.md Outdated
Comment thread docs/fr/installation.md
Comment thread docs/fr/installation.md Outdated
Comment thread docs/fr/research/effort-wheel-calibration.md Outdated
Comment thread docs/installation.md
Comment thread docs/installation.md Outdated
Comment thread docs/research/thread-status-feasibility.md Outdated
Comment thread docs/research/thread-status-feasibility.md Outdated
Comment thread docs/scope-and-limitations.md

Copy link
Copy Markdown
Owner Author

@codex review

Copy link
Copy Markdown
Owner Author

Review feedback addressed in cfb4868:

  • retargeted French entry-point links to docs/fr/ and *.fr.md
  • aligned focus-loss, session-navigation, and Input-version evidence with the measured state
  • replaced copyable AppSense IDs with fail-fast placeholders and added local-log redaction guidance
  • documented the actual lighting neutralisation boundary
  • corrected the French agreement issue

Revalidation after the fixes:

  • npm run validate — passed; 46 Markdown files checked
  • npm run check — passed; 99 root tests + 33 GUI tests
  • production GUI build — passed
  • git diff --check — passed

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Hooray!

Reviewed commit: cfb4868022

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@thannous
thannous merged commit 86a1a37 into main Jul 31, 2026
2 checks passed
@thannous
thannous deleted the codex/publish-bilingual-docs branch August 6, 2026 10:34
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.

1 participant