Skip to content

fix: Fix all links in repo README and associated VSCode Marketplace listing - #2066

Open
arora-saurabh448 wants to merge 4 commits into
masterfrom
fix/doc_links_readme_listing
Open

fix: Fix all links in repo README and associated VSCode Marketplace listing#2066
arora-saurabh448 wants to merge 4 commits into
masterfrom
fix/doc_links_readme_listing

Conversation

@arora-saurabh448

@arora-saurabh448 arora-saurabh448 commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Fix all links in repo README and associated VSCode Marketplace listing to point to help.altimate.ai instead of old docs site. Redirects work fine, but domain authority for help.altimate.ai is taking a hit.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to the new help center.
    • Added relevant documentation links to feature descriptions.
    • Updated the project health check documentation path.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The README now uses help.altimate.ai links for setup, feature documentation, project health checks, and FAQ information.

Changes

README documentation links

Layer / File(s) Summary
Update README documentation links
README.md
Setup, feature, health check, and FAQ links now use the Help Center paths. Additional feature links were added.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description states the problem and solution but omits the required testing, screenshot, and checklist sections. Use the repository template and add Problem, Solution, Screenshot/Demo, How to test, and completed Checklist sections.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: updating links in the README and associated VSCode Marketplace listing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/doc_links_readme_listing

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.

@kilo-code-bot

kilo-code-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 file)
  • README.md

This incremental change appends the same UTM tracking query string (utm_source=dbt-power-user&utm_medium=marketplace&utm_campaign=readme-docs) to all 13 documentation links in the README. The parameters are applied consistently — each link previously had no query string, so the leading ? is correct and no URL is malformed. No code or behavior change; trivial doc-only diff.

Previous Review Summary (commit 555046c)

Current summary above is authoritative. Previous snapshots are kept for context only.

Previous review (commit 555046c)

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 file)
  • README.md

This is a documentation-only change that migrates 13 documentation links from the old docs.myaltimate.com domain to help.altimate.ai/dbt-power-user. All links are updated consistently — no stale docs.myaltimate.com references remain, and link paths are preserved across the migration (the healthcheck link moved to govern/governance/, which aligns with the docs site's feature-area reorganization).


Reviewed by glm-5.2 · Input: 32.3K · Output: 6.9K · Cached: 241.3K

Review guidance: REVIEW.md from base branch master

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 72-74: Update the “Compiled query preview and explanation”
description in the README to replace “as your write code” with “as you write
code,” leaving the rest of the text unchanged.
- Line 102: Update the documentation link in README.md to use the general Power
User FAQ destination for this generic “additional info” reference, or rename its
visible label to explicitly indicate “security FAQ” if the security-specific
destination must remain.
- Around line 50-52: Update the documentation link in the genmodel section to
point to the model-generation guidance covering both workflows: generating
models from sources and converting SQL into dbt models. Use separate links for
the source and SQL workflows, or replace the current destination with a page
that documents both, while preserving the surrounding description.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: aae95ffd-e2f3-4b88-bc4c-ee3adfbab7f3

📥 Commits

Reviewing files that changed from the base of the PR and between e6fc4b3 and 555046c.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
Comment on lines +50 to +52
### <a id="genmodel"> Generate dbt™ Models from source or SQL</a>

Generate dbt™ models from sources defined in YAML. You can also convert existing SQL to a dbt™ model where references get populated automatically. [(docs)](https://docs.myaltimate.com/develop/clicktorun/)
Generate dbt™ models from sources defined in YAML. You can also convert existing SQL to a dbt™ model where references get populated automatically. [(docs)](https://help.altimate.ai/dbt-power-user/develop/clicktorun/)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Link model-generation guidance to the model-generation pages.

The new destination is the “Click to build parent/child models” page. The Help Center has separate pages for generating models from sources and SQL, so this link opens a different feature page. (help.altimate.ai)

Use two links, or link to a page that documents both workflows.

Proposed fix
-Generate dbt™ models from sources defined in YAML. You can also convert existing SQL to a dbt™ model where references get populated automatically. [(docs)](https://help.altimate.ai/dbt-power-user/develop/clicktorun/)
+Generate dbt™ models from sources defined in YAML. [(source docs)](https://help.altimate.ai/dbt-power-user/develop/genmodelSource/) You can also convert existing SQL to a dbt™ model where references get populated automatically. [(SQL docs)](https://help.altimate.ai/dbt-power-user/develop/genmodelSQL/)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### <a id="genmodel"> Generate dbt™ Models from source or SQL</a>
Generate dbt™ models from sources defined in YAML. You can also convert existing SQL to a dbt™ model where references get populated automatically. [(docs)](https://docs.myaltimate.com/develop/clicktorun/)
Generate dbt™ models from sources defined in YAML. You can also convert existing SQL to a dbt™ model where references get populated automatically. [(docs)](https://help.altimate.ai/dbt-power-user/develop/clicktorun/)
### <a id="genmodel"> Generate dbt™ Models from source or SQL</a>
Generate dbt™ models from sources defined in YAML. [(source docs)](https://help.altimate.ai/dbt-power-user/develop/genmodelSource/) You can also convert existing SQL to a dbt™ model where references get populated automatically. [(SQL docs)](https://help.altimate.ai/dbt-power-user/develop/genmodelSQL/)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 50 - 52, Update the documentation link in the
genmodel section to point to the model-generation guidance covering both
workflows: generating models from sources and converting SQL into dbt models.
Use separate links for the source and SQL workflows, or replace the current
destination with a page that documents both, while preserving the surrounding
description.

Comment thread README.md Outdated
Comment on lines +72 to +74
### <a id="queryexplanation"> Compiled query preview and explanation</a>

Get live preview of compiled query as your write code. Also, generate explanations for dbt™ code written previously (by somebody else). [(docs)](https://docs.myaltimate.com/develop/explanation/)
Get live preview of compiled query as your write code. Also, generate explanations for dbt™ code written previously (by somebody else). [(docs)](https://help.altimate.ai/dbt-power-user/develop/explanation/)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Correct the grammar in the query explanation description.

Replace as your write code with as you write code.

Proposed fix
-Get live preview of compiled query as your write code.
+Get live preview of compiled query as you write code.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### <a id="queryexplanation"> Compiled query preview and explanation</a>
Get live preview of compiled query as your write code. Also, generate explanations for dbt™ code written previously (by somebody else). [(docs)](https://docs.myaltimate.com/develop/explanation/)
Get live preview of compiled query as your write code. Also, generate explanations for dbt™ code written previously (by somebody else). [(docs)](https://help.altimate.ai/dbt-power-user/develop/explanation/)
### <a id="queryexplanation"> Compiled query preview and explanation</a>
Get live preview of compiled query as you write code. Also, generate explanations for dbt™ code written previously (by somebody else). [(docs)](https://help.altimate.ai/dbt-power-user/develop/explanation/)
🧰 Tools
🪛 LanguageTool

[grammar] ~74-~74: Ensure spelling is correct
Context: ... Get live preview of compiled query as your write code. Also, generate explanations...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 72 - 74, Update the “Compiled query preview and
explanation” description in the README to replace “as your write code” with “as
you write code,” leaving the rest of the text unchanged.

Source: Linters/SAST tools

Comment thread README.md Outdated
![dbt-log](media/images/dbt-log.gif)

Please check [documentation](https://docs.myaltimate.com/arch/faq/) for additional info.
Please check [documentation](https://help.altimate.ai/dbt-power-user/arch/faq/) for additional info.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Use the general Power User FAQ for this generic link.

The current destination renders “Security FAQ”. The Help Center also has a separate “FAQ” page for common extension questions. Because this link is labeled as generic additional information, point it to the general FAQ or rename the link to “security FAQ”. (help.altimate.ai)

Proposed fix
-Please check [documentation](https://help.altimate.ai/dbt-power-user/arch/faq/) for additional info.
+Please check [the FAQ](https://help.altimate.ai/dbt-power-user/setup/faq/) for additional info.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Please check [documentation](https://help.altimate.ai/dbt-power-user/arch/faq/) for additional info.
Please check [the FAQ](https://help.altimate.ai/dbt-power-user/setup/faq/) for additional info.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 102, Update the documentation link in README.md to use the
general Power User FAQ destination for this generic “additional info” reference,
or rename its visible label to explicitly indicate “security FAQ” if the
security-specific destination must remain.

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

Bundle Size Report

darwin-arm64: 75.7 MB
Category Size Compressed Files
Native: altimate-core 43.1 MB 15.4 MB 1
Webview JS bundles 36.2 MB 12.3 MB 346
Media assets 29.6 MB 25.8 MB 91
Native: zeromq 20.5 MB 8.2 MB 15
Webview images 15.3 MB 12.2 MB 18
Extension backend (JS) 2.8 MB 0.6 MB 1
Python packages 2.0 MB 0.5 MB 95
Native: other node_modules 1.0 MB 0.2 MB 139
Webview CSS 0.8 MB 0.2 MB 2
Webview other 0.5 MB 0.1 MB 5
Other 0.1 MB 31 KB 17
Total 151.8 MB 75.5 MB 730
linux-x64: 77.6 MB
Category Size Compressed Files
Native: altimate-core 50.7 MB 16.8 MB 1
Webview JS bundles 36.2 MB 12.3 MB 346
Media assets 29.6 MB 25.8 MB 91
Native: zeromq 21.9 MB 8.7 MB 16
Webview images 15.3 MB 12.2 MB 18
Extension backend (JS) 2.8 MB 0.6 MB 1
Python packages 2.0 MB 0.5 MB 95
Native: other node_modules 1.0 MB 0.2 MB 139
Webview CSS 0.8 MB 0.2 MB 2
Webview other 0.5 MB 0.1 MB 5
Other 0.1 MB 31 KB 17
Total 160.8 MB 77.4 MB 731
win32-x64: 78.0 MB
Category Size Compressed Files
Native: altimate-core 55.9 MB 17.4 MB 1
Webview JS bundles 36.2 MB 12.3 MB 346
Media assets 29.6 MB 25.8 MB 91
Native: zeromq 20.0 MB 8.1 MB 15
Webview images 15.3 MB 12.2 MB 18
Extension backend (JS) 2.8 MB 0.6 MB 1
Native: other node_modules 2.3 MB 0.7 MB 147
Python packages 2.0 MB 0.5 MB 95
Webview CSS 0.8 MB 0.2 MB 2
Webview other 0.5 MB 0.1 MB 5
Other 0.1 MB 31 KB 17
Total 165.4 MB 77.9 MB 738

The 13 doc links repointed in the previous commit land on help.altimate.ai
with no attribution, so clicks from the extension are indistinguishable from
organic docs traffic in PostHog.

Uses the convention already in this README rather than a new one: the two
support links carry `utm_source=dbt-power-user&utm_medium=marketplace`, so
these match that source and medium exactly and add
`utm_campaign=readme-docs` to separate doc links from the support links.
A second source name for the same surface would split attribution in two.

`utm_medium=marketplace` is kept even though this README also renders on
GitHub — one file serves both surfaces, so they cannot be distinguished by
UTM, and the existing links already made that call.

Only URLs changed; no prose. The third-party docs.getdbt.com link is left
alone. All 12 unique targets verified 200 with the params applied.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 86: Update the SQL validator description in the README to replace
“columns no present in database” with “columns not present in the database,”
leaving the rest of the text unchanged.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c2523309-0b96-48a4-ae2e-4daab52cc1c7

📥 Commits

Reviewing files that changed from the base of the PR and between 555046c and 8a237f6.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
### <a id="validateSQL"> SQL validator</a>

Validate SQL to identify issues like mistyped keywords, extra parentheses, columns no present in database [(docs)](https://docs.myaltimate.com/test/sqlvalidation/)
Validate SQL to identify issues like mistyped keywords, extra parentheses, columns no present in database [(docs)](https://help.altimate.ai/dbt-power-user/test/sqlvalidation/?utm_source=dbt-power-user&utm_medium=marketplace&utm_campaign=readme-docs)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Correct the SQL validator description.

Replace columns no present in database with columns not present in the database.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 86, Update the SQL validator description in the README to
replace “columns no present in database” with “columns not present in the
database,” leaving the rest of the text unchanged.

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.

2 participants