Add file format examples to the documentation #9078
Labels
documentation
Improvements or additions to the documentation.
enhancement
Adding or requesting a new feature.
good first issue
Opportunity for newcoming contributors.
hacktoberfest
This is suitable for Hacktoberfest. Don’t try to spam.
help wanted
Extra attention is needed.
Milestone
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
The text was updated successfully, but these errors were encountered: