Convert documentation information to JSON
guibranco opened this issue · 0 comments
Is your feature request related to a problem? Please describe.
Remove data from the Acronyms and abbreviations
section to a unified-multilanguage JSON file and then use json2table to convert JSON to a Markdown table in both (and future) README files.
Describe the solution you'd like
Merge the Acronyms and abbreviations
sections from both readme files into a single JSON with acronym and description in EN-US
and PT-BR
language. Then use the JSON2Table GH action to extract this info from the JSON file and generate a Markdown table in both README files.
A structure for the file would be something like this:
{
"acronym": "BCB",
"pt_BR": "Banco Central do Brasil (autoridade reguladora) (também conhecido como BACEN ou BC)",
"en_US": "Brazilian Central Bank (regulatory authority)(also known as BACEN or BC)"
},
{
"acronym": "CNPJ",
"pt_BR": "Cadastro Nacional de Pessoa Jurídica - RFB",
"en_US": "National Register of Legal Entities - RFB"
}
All data are already present in both README.MD files, just need to extract it from there and create the JSON file. Then create a GH Action to read this JSON file and create the table modifying the README files.