Skip to content

Internationalization (i18n) for Vitepress Documentation #1661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jun 24, 2025

Conversation

cgjgh
Copy link
Contributor

@cgjgh cgjgh commented Apr 7, 2025

Description

🌍Internationalization (i18n) for Dashboard 2.0 Vitepress Documentation

This PR introduces support for internationalization (i18n) in the online documentation for Dashboard 2.0, aligning its structure with the implementation method used by Vitepress for its own documentation.

Key Features:

  • Reorganized documentation to follow Vitepress's i18n structure.
  • Added support for the German language.

Notes:

  • Future language additions can leverage this newly structured framework for simplified additions.

Related Issue(s)

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production

Labels

  • Includes a DB migration? -> add the area:migration label

@joepavitt joepavitt self-requested a review May 7, 2025 14:02
@cgjgh cgjgh mentioned this pull request May 7, 2025
10 tasks
@joepavitt
Copy link
Collaborator

Just acknowledging that we will get this reviewed, but given it's size, I need to set some proper time aside to ensure there are no issues introduced.

@joepavitt
Copy link
Collaborator

Am working through this, apologies it's been so long, lots of clashing expected with #1684

# Conflicts:
#	docs/.vitepress/config.js
#	docs/en/nodes/widgets/ui-progress.md
@joepavitt
Copy link
Collaborator

So I've just pushed a commit which reduces the amount of duplication in the Vite config files. There is now a single config.json where the content is injected based on the selected language. There are then translation dictionaries in place for English & German, with the English setup as the backup should an entry not exist in the German file.

@joepavitt
Copy link
Collaborator

now to handle the merge conflicts with #1684

# Conflicts:
#	docs/.vitepress/config.js
#	docs/en/contributing/guides/state-management.md
#	docs/en/contributing/widgets/core-widgets.md
#	docs/en/getting-started.md
#	docs/en/user/migration.md
#	docs/en/user/template-examples.md
@joepavitt
Copy link
Collaborator

Unrelated test failure, so this is good to go. Thanks for the great work @cgjgh

@joepavitt joepavitt merged commit db0b601 into FlowFuse:main Jun 24, 2025
1 of 2 checks passed
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.

2 participants