Data Documentation

The Data Catalog in the Paradime Code IDE uses DinoAI to automatically generate detailed documentation for your data models and columns, saving time and ensuring consistency in your data documentation practices.

Autogenerating Data Documentation

DinoAI's data catalog functionality provides context-specific descriptions for the models and columns in your project, offering clear explanations of your data assets.

How to Use

1. Open the Catalog Tab: Navigate to the Catalog tab within the Apps Panel in the Code IDE.

💡 You can click the "Expand" icon on the right-hand side to maximize the catalog view.

1. Autogenerate Descriptions: At the top left of the Catalog panel, select the "Autogenerate" option to generate descriptions for your models and columns.

💡 If you're not satisfied with the initial descriptions, you can repeat the "Autogenerate" step to regenerate the content.

1. Review and Edit: Examine the autogenerated descriptions and make any necessary edits to ensure they accurately reflect your project's context and requirements.

💡 You can leverage the formatting toolbar to improve the structure and readability of your descriptions.

1. Save Changes: Once you're satisfied with the documentation, click the "Save" icon to persist the updates. These changes will be immediately reflected in the corresponding .yml files.

The autogenerated data catalog documentation helps improve clarity and collaboration around your data assets within your organization. If you have any other questions, please don't hesitate to reach out to the Paradime support team.