Skip to content

Commit

Permalink
update README generation
Browse files Browse the repository at this point in the history
  • Loading branch information
SteGala committed Mar 18, 2024
1 parent 8045aa6 commit ee25d3f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/generate_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ def generate_html(data, depth, res):
filenames = ["flavor.json", "flavor-types/k8slice.json", "flavor-types/service.json", "flavor-types/vm.json", "flavor-types/sensor.json"]
res = [""]
res.append("```")
res.append("DISCLAIMER #1: The content of this document is automatically generated upon pushing the files on GitHub. The generation starts from the JSON schema and examples contained in the repository. Do not try to modify this document, just the JSON files.")
res.append("DISCLAIMER #1: The content of this document is automatically generated upon pushing the files on GitHub. \nThe generation starts from the JSON schema and examples contained in the repository. \nDo not try to modify this document, just the JSON files.")
res.append("```")
res.append("```")
res.append("DISCLAIMER #2: Still, the generation of examples of JSONs (starting from the schema) is not automated yet. Therefore, we suggest to use tools like ChatGPT or Gemini, providing the JSON schema to the prompt and asking for an example of compliant JSON.")
res.append("DISCLAIMER #2: Still, the generation of examples of JSONs (starting from the schema) is not automated yet. \nTherefore, we suggest to use tools like ChatGPT or Gemini, providing the JSON schema to the prompt and asking for an example of compliant JSON.")
res.append("```")
res.append("In the following we represent some examples of JSON, you can find the original JSON schemas [here](models/schemas).")

Expand Down

0 comments on commit ee25d3f

Please sign in to comment.