Skip to content

Conversation

@zjrgov
Copy link
Contributor

@zjrgov zjrgov commented Nov 7, 2025

Changes proposed in this pull request:

  • Adds make db-docs-gen, which runs tbls via go run github.com/k1LoW/tbls@v1.91.2
    • Noting that I pinned to the latest version of the tool, not sure we think that's necessary.
    • I considered adding this as a Go tool, but adds a huge amount of noise to the go.mod and I wasn't sure it was worth that.
    • An alternative would be to run brew install tbls, or otherwise download the binary.
  • Might be nice to have this run in a git-hook pre-commit when there's an update to migrations, but IMO would rather address that in a separate PR that also automates other automatic generations, i.e. for Tern.
  • Configures tbls to load DB connection info from environment, use mermaid for diagrams (was more readable than SVG), increase diagram spacing for legibility, and exclude tool tables for tern and river.
  • Commits the generated documentation (I am particularly excited for the mermaid diagrams).
  • Adds notes to main README.md w/ links to other doc files and info about regenerating the schema docs

Security considerations

Runs a third-party tool to generate documentation.

@zjrgov zjrgov self-assigned this Nov 7, 2025
@zjrgov zjrgov marked this pull request as ready for review November 7, 2025 22:13
@zjrgov zjrgov requested review from a team as code owners November 7, 2025 22:13
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.

2 participants