Skip to content

Add DataGrip instructions to contributing README #2352

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.

Sign up for GitHub

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

Closed
dimaMachina wants to merge 1 commit into from
Closed

Add DataGrip instructions to contributing README #2352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .../community/contributing/connect-to-manage-database-datagrip/click-go-to-ddl.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...ibuting/connect-to-manage-database-datagrip/create-a-postgresql-data-source.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...y/contributing/connect-to-manage-database-datagrip/fill-data-source-details.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 92 additions & 0 deletions ...cs/content/community/contributing/connect-to-manage-database-datagrip/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
title: Connect to the manage database in DataGrip
sidebarTitle: DataGrip
description: This guide explains how to connect DataGrip to the local Inkeep manage database and run branch-scoped queries on a project branch.
keywords: DataGrip, PostgreSQL, Doltgres, manage database, contributors, local development
icon: LuDatabase
---

<Steps>
Copy link
Copy Markdown
Contributor

@claude claude Bot Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟠 MAJOR: Missing prerequisite — pnpm setup-dev

Issue: The guide jumps straight into DataGrip setup without mentioning that the local manage database must be running first.

Why: Contributors following this guide without running pnpm setup-dev will hit connection failures at Step 4 ("Test Connection") with no explanation. The Doltgres database on port 5432 only exists after setup-dev runs.

Fix: Add a prerequisites callout before Step 1:

<Note>
Before starting, ensure you've completed the [contributor setup](/community/contributing/overview) and run `pnpm setup-dev` to start the local databases.
</Note>

<Steps>

Refs:

<Step>
## Download DataGrip

Install the latest version of DataGrip from JetBrains:
[DataGrip download](https://jetbrains.com/datagrip/download).
</Step>
<Step>
## Create a PostgreSQL data source

In DataGrip, go to:
`File -> New -> Data Source -> PostgreSQL -> PostgreSQL`.

<>![Create a PostgreSQL data source](./create-a-postgresql-data-source.png)</>
</Step>
<Step>
## Fill data source details

Use this URL:

```text
jdbc:postgresql://localhost:5432/inkeep_agents?user=appuser&password=password
```

Or fill the fields with these values:

- Name: `Inkeep Manage API`
- User: `appuser`
- Password: `password`
- Database: `inkeep_agents`

<>![Fill data source details](./fill-data-source-details.png)</>
</Step>
<Step>
## Test the connection

Click **Test Connection** and confirm it succeeds.

<>![Test connection](./test-connection.png)</>
</Step>
<Step>
## Select databases

In **Database Explorer**, click the 3 dots next to **No databases selected** and select all databases.

<>![Select databases](./select-databases.png)</>
</Step>
<Step>
## Go to DDL

Select the `inkeep_agents` database and click **Go to DDL**.

<>![Click go to DDL](./click-go-to-ddl.png)</>
</Step>
<Step>
## Check out a Dolt branch and run a query
Copy link
Copy Markdown
Contributor

@claude claude Bot Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Minor: Missing link to conceptual documentation

Issue: This step introduces DOLT_CHECKOUT and the branch naming convention without linking to the existing manage-database.mdx page that explains why branch checkout is required.

Why: Contributors unfamiliar with Doltgres may not understand why this step is necessary. The conceptual page explains that each project has an isolated branch and connections default to main.

Fix: Add a brief explanation with a link:

## Check out a Dolt branch and run a query

The manage database uses [Doltgres branch isolation](/community/contributing/manage-database#branch-naming-convention). Each project has its own branch, so you must check out the correct branch before querying project data.

In the query console, check out the project branch first, then run your SQL.

Refs:


In the query console, check out the project branch first, then run your SQL.

Example for the default sample project:

```sql
SELECT DOLT_CHECKOUT('default_activities-planner_main');
SELECT * FROM skills;
```

General branch pattern:

```sql
SELECT DOLT_CHECKOUT('{tenant_id}_{project_id}_{branch}');
```

Run queries with `Cmd/Ctrl + Enter`, then choose the statement to execute.

<>![Run checkout and query](./run-checkout-and-query.png)</>
</Step>
<Step>
## View results

Query results appear in the bottom panel of the IDE.

<>![Query results](./query-results.png)</>
</Step>
</Steps>
1 change: 1 addition & 0 deletions agents-docs/content/community/contributing/connect-to-manage-database-datagrip/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "pages": ["index"] }
Binary file added ...nt/community/contributing/connect-to-manage-database-datagrip/query-results.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...ity/contributing/connect-to-manage-database-datagrip/run-checkout-and-query.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...community/contributing/connect-to-manage-database-datagrip/select-databases.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .../community/contributing/connect-to-manage-database-datagrip/test-connection.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions agents-docs/content/community/contributing/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"overview",
"project-constraints",
"manage-database",
"...connect-to-manage-database-datagrip",
"spans",
"environment-configuration",
"..."
Expand Down
26 changes: 16 additions & 10 deletions agents-docs/src/mdx-components.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { createGenerator } from 'fumadocs-typescript';
import { ImageZoom } from 'fumadocs-ui/components/image-zoom';
import defaultMdxComponents from 'fumadocs-ui/mdx';
import type { MDXComponents } from 'mdx/types';
import NextImage from 'next/image';
import { ComparisonTable } from '@/components/comparisons-table';
import { AutoTypeTable, type TypeLinksInput } from '@/components/mdx/auto-type-table';
import { BigVideo } from '@/components/mdx/big-video';
Expand Down Expand Up @@ -82,16 +83,21 @@ export function getMDXComponents(components?: MDXComponents): MDXComponents {
/>
),
...components,
img: (props) => (
<img
alt={props.alt ?? 'Image'}
{...props}
height={props.height ?? 1200}
width={props.width ?? 1200}
sizes="100vw"
style={{ ...props.style, borderRadius: '10px', width: '100%' }}
/>
),
img(props) {
const ComponentToUse = typeof props.src === 'object' ? NextImage : 'img';
const img = (
<ComponentToUse {...props} className="rounded-lg border border-border w-auto mx-auto" />
Copy link
Copy Markdown
Contributor

@claude claude Bot Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟠 MAJOR: Missing width/height causes CLS

Issue: The new img handler doesn't pass through width/height props, unlike the Image component above (lines 79-80) which defaults to 1200×1200.

Why: Without explicit dimensions, images cause Cumulative Layout Shift (CLS) as they load. The new DataGrip guide has 8 images — users will see content jumping as each loads.

Fix:

Suggested change
<ComponentToUse {...props} className="rounded-lg border border-border w-auto mx-auto" />
<ComponentToUse {...props} width={props.width ?? 1200} height={props.height ?? 1200} className="rounded-lg border border-border w-auto mx-auto" />

Refs:

);
if (!props.alt) {
Copy link
Copy Markdown
Contributor

@claude claude Bot Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Minor: Missing fallback alt text

Issue: When props.alt is falsy, images render without any alt attribute. The Image component above (line 77) uses alt={props.alt ?? 'Image'} as a fallback.

Why: Images without alt are less accessible. While the DataGrip guide provides alt text for all images, future MDX authors may omit it.

Fix:

Suggested change
if (!props.alt) {
if (!props.alt) {
return <ComponentToUse {...props} alt="" width={props.width ?? 1200} height={props.height ?? 1200} className="rounded-lg border border-border w-auto mx-auto" />;

Refs:

return img;
}
return (
<figure>
{img}
<figcaption className="mt-2 text-center text-sm">{props.alt}</figcaption>
</figure>
);
},
Accordions,
Accordion,
BigVideo,
Expand Down
Loading