netspective-labs / sql-aide

SQL Aide (SQLa) Typescript template literal text supplier optimized for emitting SQL
https://www.sql-aide.com/
MIT License
10 stars 17 forks source link

Improve Data Governance and Lineage Documentation #164

Open vinodkalpaka opened 9 months ago

vinodkalpaka commented 9 months ago

This Git ticket is dedicated to enhancing our data governance and data lineage documentation in the codebase. The key objectives are:

Implement a parser to extract data governance and lineage information from SQL files. Review and align existing documentation with code elements to ensure correct associations. Validate the schema generation process. Convert parsed documentation into JSON for storage. Create a VSCode extension for schema typing checks.

We need to ensure that code documentation, specifically JSDoc-style comments, is correctly associated with the relevant sections of code. The goal is to review the existing codebase and confirm that the comments accurately describe the corresponding code elements, such as DDLs, stored procedures, stored functions, etc. This work will improve the accuracy and consistency of our data governance documentation.