Add the multi language support, and add the german version in the docs #1224

Esscraye · 2025-09-21T19:34:03Z

Description

This pull request adds VitePress multi-language support and includes a complete German (de) translation of the documentation under de.

Changes

Context

This change enables multi-language documentation for the site and provides a full German translation, allowing German-speaking users to read the docs in their native language. It adds locale-aware configuration in config.ts (helpers for nav and sidebar) and places all translated content under docs/de. No functional changes to the application or runtime are included — only documentation and site config updates.

How Has This Been Tested?

Manually inspected translated pages to ensure frontmatter, code blocks and links were preserved.
Built and previewed the site locally
Tested on Arch Linux/Based Distro.
Tested on Fedora Linux/Based Distro.
Tested on openSuse.

Checklist

Please ensure your pull request meets the following requirements:

My code follows the style guidelines of this project. (Docs/config follow existing conventions.)
I have performed a self-review of my changes.
I have commented on my code, particularly in hard-to-understand areas (locale helpers in config.ts are commented).
My changes do not introduce new warnings.
[-] I have added tests that prove my fix is effective or that my feature works. (N/A for docs-only change.)
I have made corresponding changes to the documentation.
[-] New and existing unit tests pass locally with my changes. (N/A / no code changes)

Screenshots

Related Issues

N/A

Additional Notes

This PR contains only documentation and site configuration changes (i18n support + translations). and fix 2 small changes in the english version (sh -> ini and spappy --> swappy)

Esscraye · 2025-10-03T02:48:08Z

Hi @mylinuxforwork I wanted to add the french version too, but i was afraid to create a PR with 80 new files ^^.

So tell me, if you want to merge the PR, do you want me to add a commit for the french version or i wait to create a new PR when this one will be merged ? :)

mylinuxforwork · 2025-10-06T12:56:40Z

@Esscraye Thank you so much for your work. But I would currently pause your request. It would be hard for me to maintain two language versions in the docs. But maybe you can support me in the general english version?

harilvfs · 2025-10-11T08:14:05Z

@Esscraye thanks for your work, LGTM. can you provide me the site URL deployed with the GitHub actions workflow? I want to check if everything works.

edit: also can you like update the docs in de in upcoming times, like if the normal eng version changes, can you also update the de version yourself. i can agree with ml4w that maintaining two languages is a bit difficult when there are too many things in the docs, so if you can help ml4w while maintaining the docs in de, it will be good to have them in de lang.

if you can lend your helping hand in future updates of the docs, we can look further to have de lang in the docs.
if you won't have time to do this, then it will be hard for ml4w to maintain both languages. i hope you understand. once again, thanks for your time and work.

Esscraye · 2025-10-16T13:55:11Z

hey, I don't think i've the time to maintain the german version, i'm sorry about that ^^

@harilvfs it should be that : https://esscraye.github.io/ml4w-dotfiles/ but it seems the github-page is not really working well ?

…an (de) translation

Copilot

Pull request overview

This pull request adds comprehensive multi-language support to the VitePress documentation site and provides a complete German (de) translation. The changes enable German-speaking users to access the ML4W Dotfiles documentation in their native language while maintaining the existing English documentation.

Key changes:

Implemented VitePress i18n infrastructure with locale-aware navigation and sidebar helpers
Added complete German translation covering all documentation sections
Fixed minor issues in English documentation (typo corrections and updated links)

Reviewed changes

Copilot reviewed 43 out of 43 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
docs/usage/screenshots.md	Fixed typo: "spappy" → "swappy"
docs/usage/keybindings.md	Updated GitHub link path from share/dotfiles to dotfiles
docs/help/troubleshooting.md	Changed code fence language from `sh` to `ini` for SDDM config
docs/development/wiki.md	Added multi-language setup instructions and removed outdated information
docs/.vitepress/config.ts	Implemented locale system with nav() and sidebar() helper functions supporting i18n
docs/de/*/.md	Complete German translation of all documentation pages
docs/de/showcases/*.{ts,vue}	German version of showcase components
docs/customization/displaymanager.md	Changed code fence language from `sh` to `ini` for configuration examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-27T17:40:57Z

docs/de/customization/browser.md

+
+</div>
+
+As an example, let's install brave.


This line contains English text in a German translation file. It should be translated to German. The English text "As an example, let's install brave." appears in what should be a fully German document.

Suggested change

As an example, let's install brave.

Als Beispiel installieren wir Brave.

Copilot · 2025-12-27T17:40:57Z

docs/de/showcases/showcases.ts

+type Showcase = {
+  image: string
+  title: string
+}


The TypeScript type definition is incomplete. The type declares 'image' and 'title' as required properties, but objects in the array use 'videoUrl' which is not defined in the type. The type should include 'videoUrl' as an optional property, or the properties should be marked as optional.

Copilot · 2025-12-27T17:40:58Z

docs/development/wiki.md

+>
+> Documentation in languages other than English may not be up to date. Check the date and the ml4w version shown, and consult the English documentation if in doubt.
+
+** To add a new language, follow these steps:**


There is an extra space before "To add a new language". The markdown has "** To add" with two asterisks and a space, which should be "**To add" without the space for proper bold formatting.

Copilot · 2025-12-27T17:40:58Z

docs/.vitepress/config.ts

+
+const sidebar = (lang = "", override = {}) => {
+  // future feature may be needed: sep sidebar for dots-installer section or any other
+  // basicallyy when user visits /dots-installer/ page it will only show dots-installer menu items


Typo in the comment: "basicallyy" should be "basically".

Suggested change

// basicallyy when user visits /dots-installer/ page it will only show dots-installer menu items

// basically when user visits /dots-installer/ page it will only show dots-installer menu items

Copilot · 2025-12-27T17:40:58Z

docs/.vitepress/config.ts

+const sidebar = (lang = "", override = {}) => {
+  // future feature may be needed: sep sidebar for dots-installer section or any other
+  // basicallyy when user visits /dots-installer/ page it will only show dots-installer menu items
+  // just like how vitepress docs sep "refrence" section https://vitepress.dev/


Typo in the comment: "refrence" should be "reference".

Suggested change

// just like how vitepress docs sep "refrence" section https://vitepress.dev/

// just like how vitepress docs sep "reference" section https://vitepress.dev/

feat(docs): Add the multi language support, and add the complete germ…

b715815

…an (de) translation

Copilot AI review requested due to automatic review settings December 27, 2025 17:38

Esscraye force-pushed the main branch from 7ceb60d to b715815 Compare December 27, 2025 17:38

Copilot started reviewing on behalf of Esscraye December 27, 2025 17:38 View session

Copilot AI reviewed Dec 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add the multi language support, and add the german version in the docs #1224

Add the multi language support, and add the german version in the docs #1224

Uh oh!

Esscraye commented Sep 21, 2025

Uh oh!

Esscraye commented Oct 3, 2025

Uh oh!

mylinuxforwork commented Oct 6, 2025

Uh oh!

harilvfs commented Oct 11, 2025 •

edited

Loading

Uh oh!

Esscraye commented Oct 16, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 27, 2025

Uh oh!

Copilot AI Dec 27, 2025

Uh oh!

Copilot AI Dec 27, 2025

Uh oh!

Copilot AI Dec 27, 2025

Uh oh!

Copilot AI Dec 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	As an example, let's install brave.
	Als Beispiel installieren wir Brave.

	// basicallyy when user visits /dots-installer/ page it will only show dots-installer menu items
	// basically when user visits /dots-installer/ page it will only show dots-installer menu items

	// just like how vitepress docs sep "refrence" section https://vitepress.dev/
	// just like how vitepress docs sep "reference" section https://vitepress.dev/

Add the multi language support, and add the german version in the docs #1224

Are you sure you want to change the base?

Add the multi language support, and add the german version in the docs #1224

Uh oh!

Conversation

Esscraye commented Sep 21, 2025

Description

Changes

Context

How Has This Been Tested?

Checklist

Screenshots

Related Issues

Additional Notes

Uh oh!

Esscraye commented Oct 3, 2025

Uh oh!

mylinuxforwork commented Oct 6, 2025

Uh oh!

harilvfs commented Oct 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Esscraye commented Oct 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

harilvfs commented Oct 11, 2025 •

edited

Loading