Merged
Conversation
…ity by consolidating page arrays into single-line entries. Updated French translations for various sections, including user guide and developer resources, ensuring consistency in terminology.
…ks in translated documentation. Update `package.json` to include a new script for link fixing and modify the workflow to run this script before committing changes.
…lated documentation. Consolidate link replacement commands for user-guide, developers, and twenty-ui sections, ensuring consistency across language directories.
Contributor
There was a problem hiding this comment.
Greptile Overview
Greptile Summary
This PR introduces automated translation management for the Twenty documentation by pulling French translations from Crowdin and fixing internal links. The main enhancement is a new bash script (fix-translated-links.sh) that automatically adds locale prefixes (e.g., /fr/) to internal documentation links in translated files, ensuring proper navigation in multi-language documentation.
Key Changes:
- Added automated link-fixing script that processes all language directories dynamically
- Updated GitHub Actions workflow to run link fixing after pulling translations
- Changed workflow to use
${{ github.ref }}instead of hardcodedmainbranch reference - Added 30+ new French translation files for developers, UI components, and user guide sections
- Updated
docs.jsonwith French navigation group names ("Guide utilisateur", "Modèle de données", etc.) - Fixed internal links in existing French documentation to include
/fr/prefix
The implementation follows a clean post-processing approach where Crowdin pulls translations first, then the script automatically fixes all internal links before committing changes.
Confidence Score: 5/5
- This PR is safe to merge with minimal risk - it only affects documentation translations and automation
- The changes are well-structured and low-risk: the bash script uses safe sed operations with backup files, the workflow changes are minimal and improve functionality, and all modifications are isolated to documentation files. The script properly handles edge cases (empty directories, excluded directories) and uses set -e for error handling. No application code is affected.
- No files require special attention - all changes are straightforward documentation and automation improvements
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| .github/workflows/docs-i18n-pull.yaml | 5/5 | Workflow updated to use current branch ref and run link-fixing script after pulling translations from Crowdin |
| packages/twenty-docs/scripts/fix-translated-links.sh | 5/5 | New bash script that automatically fixes internal documentation links by adding locale prefixes to translated files |
| packages/twenty-docs/package.json | 5/5 | Added new fix-links npm script to run the link-fixing script |
| packages/twenty-docs/docs.json | 5/5 | Updated French documentation navigation with translated group names and formatting improvements |
Sequence Diagram
sequenceDiagram
participant GHA as GitHub Actions
participant Crowdin
participant Script as fix-translated-links.sh
participant Repo as Repository
GHA->>Repo: Checkout i18n branch
GHA->>Crowdin: Pull French translations
Crowdin-->>Repo: Download .mdx files to fr/ directory
GHA->>Script: Execute link fixing script
Script->>Script: Find all language directories
Script->>Script: Process each .mdx file
Script->>Script: Replace /user-guide/ with /fr/user-guide/
Script->>Script: Replace /developers/ with /fr/developers/
Script->>Script: Replace /twenty-ui/ with /fr/twenty-ui/
Script-->>Repo: Updated files with locale prefixes
GHA->>Repo: Commit changes to i18n branch
GHA->>Repo: Create pull request to main
38 files reviewed, no comments
Contributor
Author
LogDetails |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Created by Github action