Convert data-fields.txt into markdown to let it be more readable

[CharlesNepote]

I'm going to enhance the documentation of the fields exported in CSV (data-fields.txt).

Is it ok if I convert it into a markdown file to allow better readability in Github and elsewhere?

• links
• titles
• code
• etc.

[ayush78781]

How about enhancing the documentation using readthedocs as it enable us to not only host our markdown format documentation but also allow us to integrate it with any VCS. And, if its sounds good to you. I take the ownership of its completion.

[CharlesNepote]

I started a first draft here: https://github.com/openfoodfacts/openfoodfacts-server/blob/issue-2325/html/data/data-fields.md

@ayush78781 : readthedocs is very interesting but too rich/complex for this. Let's start with a simple .md file.

[alexgarel]

@CharlesNepote we have a documentation build process with mkdocs, we could include this file when it's ready. It's displayed on https://openfoodfacts.github.io/openfoodfacts-server/ in the reference section.

[ayush78781]

I started a first draft here: https://github.com/openfoodfacts/openfoodfacts-server/blob/issue-2325/html/data/data-fields.md

@ayush78781 : readthedocs is very interesting but too rich/complex for this. Let's start with a simple .md file.

@CharlesNepote it shows you already done. Are there any improvement required in this?

[alexgarel]

@ayush78781 I convinced @CharlesNepote to instead document fields in the OpenAPI (as separate files), so we avoid duplicating doc, and we can still generate the .md file from it.

[alexgarel]

If you want to help, you are welcome @ayush78781 :-)

[github-actions[bot]]

This issue is stale because it has been open 90 days with no activity.