pyglet icon indicating copy to clipboard operation
pyglet copied to clipboard

Localization of documentation

Open DimaFyodorov opened this issue 7 months ago • 5 comments

Why? Documentation is the main source of information about the project, and its availability is important. Adding support for other languages ​​(even partial) will simplify the learning process and expand the circle of potential users of pyglet.

How? readthedocs.io has documentation for localizing documentation. I suggest moving the documentation to a separate pyglet repository.

DimaFyodorov avatar May 28 '25 20:05 DimaFyodorov

Thanks for opening the ticket. We have had some interest in localizing the documentation over the years, but we don't have any contributors who are willing to commit to maintaining documentation yet. Perhaps starting by moving to an /en/ subfolder would be a good move though.

Why would you recommend moving to a different repository for documentation? Is it just easier to maintain, or, is there a technical advantage?

benmoran56 avatar Jun 01 '25 01:06 benmoran56

Thank you for your answer, I am sure that among users around the world there are those who are ready to help with translating the documentation into their language.

As for a separate repository, it can help with development. All updates in one place, issue and pull requests for documentation will not affect the library and vice versa, I think it will be more convenient. Perhaps this will simplify deployment, but it is not a fact, we need to test.

DimaFyodorov avatar Jun 01 '25 02:06 DimaFyodorov

I can try to help, but I will need to brush up on my knowledge.

DimaFyodorov avatar Jun 01 '25 02:06 DimaFyodorov

All updates in one place, issue and pull requests for documentation will not affect the library and vice versa

My understanding is that single-repo tends to simplify deployment for docs and onboarding contributors. The main advantage may be for large tutorial series, which pyglet does not have.

pushfoo avatar Jun 01 '25 19:06 pushfoo

Maybe, I honestly have little experience in this.

DimaFyodorov avatar Jun 01 '25 21:06 DimaFyodorov