Skip to content

update docs#2

Merged
jeff-dude merged 1 commit intomainfrom
update-docs
Oct 2, 2025
Merged

update docs#2
jeff-dude merged 1 commit intomainfrom
update-docs

Conversation

@jeff-dude
Copy link
Member

@jeff-dude jeff-dude commented Oct 2, 2025

Note

Revamps documentation to Dune-focused setup with dbt packages, example models, and detailed CI/CD workflow.

  • Docs:
    • QUICKSTART.md: Reorders steps; adds uv sync, dbt deps, Dune profile setup (hosts, API key, transformations: true), example models (view/table/incremental), tests, incremental run guidance, and expanded troubleshooting.
    • README.md: Renames project to Dune DBT Template; expands project structure (workflows, macros, scripts); adds Dune connection guidance, dbt packages, example models, custom macros, CI/CD pipeline overview, environment-specific behavior, and troubleshooting.
    • WORKFLOW.md: Details local dev flow (compile/run/test), handling model types, managing Python/dbt packages, full CI/CD pipeline steps, runner config, schema naming by environment, PR workflow, and troubleshooting.
  • CI/CD:
    • Documents PR workflow using GitHub Actions with cluster activation, full refresh + incremental runs, and tests; uses test_schema via generate_schema_name.

Written by Cursor Bugbot for commit 6d9734c. This will update automatically on new commits. Configure here.

@jeff-dude
Copy link
Member Author

docs are over the top verbose, but will keep for now and iterate as we proceed

@jeff-dude jeff-dude merged commit 48f5ff6 into main Oct 2, 2025
2 checks passed
@jeff-dude jeff-dude deleted the update-docs branch October 2, 2025 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant