Skip to content

generated-reference-docs.instructions.md

Latest commit

 

History

History
28 lines (19 loc) · 1.17 KB

generated-reference-docs.instructions.md

File metadata and controls

28 lines (19 loc) · 1.17 KB
applyTo CYPHER.md,SCRIPTS.md,ENVIRONMENT_VARIABLES.md

Generated Reference Files

CYPHER.md, SCRIPTS.md, ENVIRONMENT_VARIABLES.md — auto-generated. Do not edit directly. Changes get overwritten.

Do Not Run Generators Manually

Generators run automatically in pipeline — output auto-committed. Running locally, including result in commit causes git merge conflicts in pipeline. Only run generator if user explicitly insists.

Influence Indirectly

File Edit instead
CYPHER.md First line // Description. of each .cypher file
SCRIPTS.md First line # Description. of each .sh file
ENVIRONMENT_VARIABLES.md Inline # comment after env var declaration in .sh files

Moved/renamed files detected and reflected automatically on next pipeline run.

Generators

See scripts/documentation/:

  • generateCypherReference.sh → CYPHER.md
  • generateScriptReference.sh → SCRIPTS.md
  • generateEnvironmentVariableReference.sh + appendEnvironmentVariables.sh → ENVIRONMENT_VARIABLES.md