Skip to content
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

[i18n] Add Warning Banner for Outdated Non-English Documentation Pages #3163

Open
caipeter888 opened this issue Feb 8, 2025 · 3 comments
Open
Labels
enhancement Does it add or improve content?

Comments

@caipeter888
Copy link
Contributor

Description:

I noticed that several non-English documentation pages are outdated. For instance, the Chinese prerequisites page (https://tauri.app/zh-cn/start/prerequisites/#rust) is missing the "MSVC toolchain as default" warning. While using a machine that only has stable-x86_64-pc-windows-gnu installed, I repeatedly referred to the Chinese page and couldn’t figure out the compilation error issue until I switched to the English version of the documentation.

Proposal:

Could we add an automatic warning banner at the top of any translated pages that are known to be outdated? This banner would serve to alert readers that the translated content might be missing important updates, and they should refer to the English version for the most current information—similar to how untranslated pages currently display a notice like “This content is not available in your language.”

This improvement would help prevent confusion and save developers time by guiding them to the latest documentation when issues arise due to outdated translations.

Thank you for considering this proposal.

@vasfvitor vasfvitor added the enhancement Does it add or improve content? label Feb 9, 2025
@vasfvitor
Copy link
Contributor

vasfvitor commented Feb 9, 2025

this seems a good idea, do you have any examples of this is another docs or elsewhere? Asking because I'm trying to imagine how it would be done / look like, without it being an eye sore

@caipeter888
Copy link
Contributor Author

Thank you for your reply.

I don't have many ideas regarding the exact page style.

As for the implementation, perhaps it would be feasible to compare the commit timestamps of the corresponding files in the English directory and other language directories (with the same filename) to determine if the translation is outdated.

@GuoJikun
Copy link
Contributor

Outdated logic maybe able to reference lunaria

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Does it add or improve content?
Projects
None yet
Development

No branches or pull requests

3 participants