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

Translate documentation to French #48

Open
jemsab opened this issue Jul 30, 2021 · 5 comments
Open

Translate documentation to French #48

jemsab opened this issue Jul 30, 2021 · 5 comments

Comments

@jemsab
Copy link
Collaborator

jemsab commented Jul 30, 2021

In order to be used by French tax office agents, all the project documentation needs to be translated to French

@denismerigoux
Copy link
Contributor

Does this also concern variable names and comments in the code?

@jemsab
Copy link
Collaborator Author

jemsab commented Aug 2, 2021

Not for the moment, I shall get back to you later in the summer when I have more details. As explained elsewhere, this is a PoC of translating all external documentation.

@mdurero
Copy link
Collaborator

mdurero commented Jan 18, 2023

Hello,

I have not been called upon to follow the translation through yet. Nonetheless, as I keep track of my understanding of the tax computation system mostly in French, I wondered how I could incorporate updates to the existing documentation. At the moment most Mlang documentation I know is code comments, using odoc.

So I looked ocamldoc/odoc for a bit and I'm kind of troubled as I found nothing revealing any straightforward use of them in a multilingual context. Are we doomed to build our own ad hoc tools to, for instance, keep a translated version in sync with the generated doc ?

@Keryan-dev
Copy link
Collaborator

Keryan-dev commented Jan 18, 2023

Would I be wrong assuming that developer documentation and user documentation are not one and the same and will not be intended to reach the same people ? If so there is a whole, mostly unwritten, part of the doc that we could decide to have only in French.

Or all the code comment, if that matters. Point is, I don't think we should have to maintain several languages for this project.

@mdurero
Copy link
Collaborator

mdurero commented Jan 18, 2023

You're right. I would argue though, that users and developers are going to be non exclusive groups, that developers from the tax office also expect French text and that part of the two docs can be shared.
Then I also understand that for publication an English version is more commonly understood.

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 a pull request may close this issue.

4 participants