Skip to content

fix: documentation about connections. Fixes issue #313#318

Merged
arora-saurabh448 merged 1 commit intomainfrom
fix/docs-connection
Mar 20, 2026
Merged

fix: documentation about connections. Fixes issue #313#318
arora-saurabh448 merged 1 commit intomainfrom
fix/docs-connection

Conversation

@arora-saurabh448
Copy link
Collaborator

@arora-saurabh448 arora-saurabh448 commented Mar 20, 2026

Summary

Fixed documentation to solve issue #313

Test Plan

How was this tested?

Checklist

  • Documentation updated (if needed)

Summary by CodeRabbit

  • Documentation
    • Updated warehouse configuration guidance to reflect new .altimate-code/connections.json file location.
    • Simplified connection configuration JSON structure with connections at the root level instead of nested under a "warehouses" key.
    • Clarified project-local and global configuration file paths.

Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review.

@arora-saurabh448 arora-saurabh448 merged commit 9c2134e into main Mar 20, 2026
9 of 10 checks passed
@arora-saurabh448 arora-saurabh448 deleted the fix/docs-connection branch March 20, 2026 04:48
@coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 13bb6978-becd-473f-9851-8d39ceedf008

📥 Commits

Reviewing files that changed from the base of the PR and between c734e19 and 8b9d69b.

📒 Files selected for processing (6)
  • docs/docs/configure/warehouses.md
  • docs/docs/getting-started.md
  • docs/docs/getting-started/quickstart-new.md
  • docs/docs/getting-started/quickstart.md
  • docs/docs/quickstart.md
  • docs/docs/reference/windows-wsl.md

Disabled knowledge base sources:

  • Jira integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

Documentation updates across multiple guides to reflect a new warehouse connection configuration structure, moving from altimate-code.json with a "warehouses" wrapper to a separate .altimate-code/connections.json file with connector definitions at the root level.

Changes

Cohort / File(s) Summary
Getting Started & Quickstart Guides
docs/docs/getting-started.md, docs/docs/getting-started/quickstart-new.md, docs/docs/getting-started/quickstart.md, docs/docs/quickstart.md
Updated configuration examples and file path references from altimate-code.json to .altimate-code/connections.json; removed top-level "warehouses" and "connections" wrapper objects, placing connector definitions (Snowflake, BigQuery, PostgreSQL, DuckDB, etc.) directly at the root level of the JSON.
Warehouse Configuration Reference
docs/docs/configure/warehouses.md
Comprehensive update to all warehouse connection examples (generic, Snowflake variants, BigQuery, Databricks, PostgreSQL, Redshift, DuckDB, MySQL, SQL Server, SSH tunneling) removing the "warehouses" wrapper; clarified config file locations specifying .altimate-code/connections.json as project-local and ~/.altimate-code/connections.json as global.
Troubleshooting & WSL Reference
docs/docs/reference/windows-wsl.md
Updated forward-slash path formatting guidance to reference .altimate-code/connections.json; adjusted DuckDB local configuration example to remove the warehouses wrapper and place the connection at root level.

Poem

🐰 Connection configs hop to a new home,
From .altimate-code.json to connections.json to roam,
No more wrappers binding tight,
Just connectors at the root—oh what a sight!
Docs all aligned in perfect array,
Configuration clarity wins the day!

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-connection
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant