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

Technical documentation in english only #39

Open
tordans opened this issue Mar 21, 2024 · 1 comment
Open

Technical documentation in english only #39

tordans opened this issue Mar 21, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@tordans
Copy link
Contributor

tordans commented Mar 21, 2024

I tried to contribute to the docs just now and it is just not fun. (See also #38.)

I wonder if one step to make this easier where to keep all those really technical docs in english only.
IMO it is far more important to have great english docs about technical stuff that can be updated super easily that it is to have them translated.

This suggestion does not apply to user facing docs that explain the UI and such, this is only about the API and data structure docs.


Another idea would be to switch to the great static side generator astro which has great i18n support using pages build in https://docs.astro.build/en/guides/internationalization/.

@jschwarz2030
Copy link
Contributor

Regarding the discussion to switch frameworks...
Astro seems to work similarly to 11ty, where each translation is a route, creating a language specific page for each doc page. I'm at this point worried static sites aren't a scalable solution for a site that will probably support 18+ languages. If we moved to a new framework, I'd advocate react/nextjs over a static site generator. A react application will have more libraries that can get us away housing all of the docs in json that's compatible with transifex. But if there's another way I'm open to it.

IMO it is far more important to have great english docs about technical stuff that can be updated super easily that it is to have them translated.

Totally agree with this. If the community wants to drive back in this direction, it may be viable too.

@mvexel mvexel added the documentation Improvements or additions to documentation label Feb 21, 2025
@mvexel mvexel moved this to To triage in MapRoulette Doc Sprint 2025 Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: To triage
Development

No branches or pull requests

3 participants