Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add config options, formatting updates, update packages #17

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

Hankanman
Copy link

I found this project a few months ago and have been maintaining my own fork of it with significant updates and improvements. I thought I should create a PR and push back to the original project if you are interested, below is a summary of the changes:

Added

  • New output formats and options:
    • LLM-optimized JSON format for AI consumption
    • Separate folder and fileName configuration options
    • Ability to generate both markdown and JSON outputs simultaneously
  • Entity Relationship Diagrams using Mermaid.js
  • Function documentation support:
    • Full function signatures
    • Function definitions
    • Language and volatility information
  • Row Level Security (RLS) policy documentation:
    • Policy definitions
    • USING expressions
    • WITH CHECK expressions
    • Role assignments
  • Enhanced schema documentation:
    • Table and column comments
    • View definitions and comments
    • Default values for columns
  • Environment variable support:
    • .env and .env.local file support
    • Database connection string via DB_STRING
  • Table of Contents generation
  • Pure markdown mode (no HTML)

Changed

  • Replaced single output option with folder and fileName for more flexibility
  • Improved configuration handling with better defaults
  • Enhanced CLI argument support for all configuration options

…or functions in documentation, and modify database connection settings. Includes new test configuration file and updates to TypeScript settings.
…, enhance configuration options with connection string, and modify output settings. Include new flags for functions in documentation generation and adjust database connection logic.
…tion configuration, enhance output options with folder and file name settings, and add support for generating diagrams and LLM-optimized JSON format. Update README for improved documentation and remove deprecated test configuration file.
…tions, enhance feature descriptions, and improve overall documentation layout.
…s, package name, and contact information. Enhance README with new badges and improve TypeScript configuration. Update CHANGELOG for clarity.
…arna/postgres-to-docs for branding consistency.
@CLAassistant
Copy link

CLAassistant commented Jan 3, 2025

CLA assistant check
All committers have signed the CLA.

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