# Catalog

In the Command Panel within the Code IDE, view and edit your dbt™ docs without context switching. Paradime will sync changes from the UI back to your dbt™ project's .yml files with each edit, ensuring consistency across your project.

{% hint style="info" %}
**Why Document Your dbt™ Project?**

Thorough documentation is a critical component of any successful dbt™ project. Well-documented models and columns provide numerous benefits:

* **Knowledge Sharing**: Makes your data models accessible to stakeholders across your organization
* **Onboarding**: Helps new team members understand your data models quickly
* **Self-Service Analytics**: Empowers business users to explore data confidently
* **Governance**: Helps track sensitive data and ownership for compliance
  {% endhint %}

### Creating and Editing Documentation

{% @arcade/embed url="<https://app.arcade.software/share/zwNErIzVcGUCIiwyzF6V>" flowId="zwNErIzVcGUCIiwyzF6V" %}

#### Step-by-Step Guide

1. Click **Catalog** to view and edit your dbt™ project's documentation in real time. By default, you'll see a catalog preview; expand it to utilize all catalog features.
2. Make your desired edits:
   * **Model Classification**
     * Edit existing classifications in the meta section
     * Add new classifications
   * **Model Description**

     * Type your model description manually
     * Use the text formatting toolbar for better readability
     * Alternatively, use [DinoAI](https://docs.paradime.io/app-help/documentation/code-ide/left-panel/copilot#data-catalog-autogenerate) to autogenerate an in-depth, context-specific description

     <figure><img src="/files/LBcCbIJAxHrwisfJ5Dz8" alt=""><figcaption></figcaption></figure>
   * **Column Details**
     * Edit individual column descriptions
     * Add or modify column classifications (e.g., `[primary_key, true]`)
3. Click **Save Changes** to apply your edits
4. When finished, [commit and push your git branch](/app-help/documentation/code-ide/left-panel/git-lite.md#committing-changes)
   * The edits you made in the UI will be reflected in the corresponding `.yml` file

### Available Documentation Features

<table><thead><tr><th width="150">Feature</th><th width="272">Description</th><th>Example</th></tr></thead><tbody><tr><td>Model Classification</td><td><p>View and/or edit your model classifications (AKA tags).</p><p>You can select an existing classification or create a new one.</p></td><td><pre class="language-yaml"><code class="lang-yaml">meta:
    is sensitive: true
    owner: data_team
</code></pre></td></tr><tr><td>Model Description</td><td>View and/or edit your model description.<br><br>Leverage DinoAI's Autogenerate feature to create a high-quality, context-specific Business summary and Technical summary</td><td><pre class="language-yaml"><code class="lang-yaml">description: >
  This is the base 
  model for our 
  customer data... 
</code></pre></td></tr><tr><td>Column Details</td><td>View and/or edit metadata for each column, including type, description, tests, and classification.<br><br>You can select an existing classification or create a new one.</td><td><pre class="language-yaml"><code class="lang-yaml">- name: customer_id
  tests:
    - unique:
       severity: warn
    - not_null:
       severity: error
  meta:
    primary_key: true
  description: >
    The unique 
    identifier of our 
    customers
</code></pre></td></tr></tbody></table>

{% hint style="info" %}
Docs Preview is built using the current version of your dbt™ repository from the git branch currently selected in the Paradime IDE and Information schema from your Development Environment default connection.
{% endhint %}

{% hint style="info" %}
For maximum efficiency, use [Dino AI](/app-help/documentation/code-ide/left-panel/copilot.md#data-catalog-autogenerate) to autogenerate comprehensive data documentation, then refine it to meet your specific needs.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.paradime.io/app-help/documentation/code-ide/command-panel/docs-preview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.