WeblateOrg / weblate

Web based localization tool with tight version control integration.
https://weblate.org/
GNU General Public License v3.0
4.63k stars 1.02k forks source link

Add file format examples to the documentation #9078

Closed nijel closed 1 year ago

nijel commented 1 year ago

Describe the problem

Some documentation of file formats include examples, but most not. It should be improved.

Describe the solution you'd like

Almost each file format page should include Example files section showing an example of such file (the exception here probably will be binary formats like Excel or IDML).

Describe alternatives you've considered

No response

Screenshots

No response

Additional context

https://docs.weblate.org/en/latest/formats/json.html already does include this.

For many of formats, the example files can be found in the test suite, so it can be included like in JSON docs: https://github.com/WeblateOrg/weblate/blob/main/docs/formats/json.rst

github-actions[bot] commented 1 year ago

This issue seems to be a good fit for newbie contributors. You are welcome to contribute to Weblate! Don't hesitate to ask any questions you would have while implementing this.

You can learn about how to get started in our contributors documentation.

pernelkanic commented 1 year ago

can i take up this issue?

nijel commented 1 year ago

Yes, any contribution is welcome.

pernelkanic commented 1 year ago

Can I get a brief on what must be done?

github-actions[bot] commented 1 year ago

Thank you for your report; the issue you have reported has just been fixed.