autodoc.config.json

{
  "name": "dune docs",
  "repositoryUrl": "https://dune.com",
  "root": ".",
  "output": "./.autodoc",
  "llms": [
    "gpt-3.5-turbo",
    "gpt-4"
  ],
  "ignore": [
    ".*",
    "*package-lock.json",
    "*package.json",
    "node_modules",
    "*dist*",
    "*build*",
    "*test*",
    "*.svg",
    "*.toml",
    "*autodoc*",
    "stylesheets",
    "javascripts",
    "images",
    "overrides",
    "zh",
    "*.png",
    "*.jpg",
    "*.gif",
    "*.pages",
    "*.yml",
    "requirements.txt",
    "README.md",
    "license.md"

  ],
  "filePrompt": "Write a detailed explanation of what this guide covers. \n Each files' topic is specified in 'description' at the top of the file \n The project feature the file is focused on is contained in the second folder of the file path (either app, api, data-tables, query, or reference). \n Focus on the high-level purpose of each header in this guide and how it applies to the section of the project app.\n Include guide examples where appropriate. Keep you response between 100 and 300 words. \n DO NOT RETURN MORE THAN 300 WORDS.\n Output should be in markdown format.\n",
  "folderPrompt": "Write a detailed explanation of what the guide in this file covers\n and how it mi ght fit into the larger project feature or work with other parts of the project.\n The project feature the file is focused on is contained in the second folder of the file path (either app, api, data tables, query, or reference). \n  Give examples of how this guide might be useful. Include guide examples where appropriate.\n      Be concise. Include any information that may be relevant to analyst who is curious about this using the project.\n       Keep you response under 400 words. Output should be in markdown format.\n      Do not just list the files and folders in this folder.",
  "chatPrompt": "Include general blockchain concept explanations where appropriate.\n",
  "contentType": "app technical guide",
  "targetAudience": "blockchain SQL analyst",
  "linkHosted": true
}