Skip to content

docs: Consolidate quickstart guide into one canonical Quickstart #1033

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

Open
sudhanshu456 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Consolidate quickstart guide into one canonical Quickstart #1033

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
2 changes: 1 addition & 1 deletion docs/docs/configure/skills.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Skills are loaded from these locations (in priority order):

## Built-in Data Engineering Skills

altimate ships with built-in skills for common data engineering tasks. Type `/` in the TUI to browse what's available and get autocomplete on skill names.
altimate ships with built-in skills for common data engineering tasks. Run `/skills` in the TUI to list what's available.

| Skill | Description |
|-------|-------------|
Expand Down
7 changes: 4 additions & 3 deletions docs/docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

@cubic-dev-ai cubic-dev-ai Bot Jul 23, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2: This file still contains a full multi-step setup guide (agent modes table, mode-switching commands, etc.) that overlaps with the now-canonical getting-started/quickstart.md. Since the goal is consolidation, consider reducing this page to a short landing/redirect that links to the canonical quickstart, otherwise readers may land here via direct links and see instructions that drift out of sync over time.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At docs/docs/getting-started.md, line 3:

<comment>This file still contains a full multi-step setup guide (agent modes table, mode-switching commands, etc.) that overlaps with the now-canonical `getting-started/quickstart.md`. Since the goal is consolidation, consider reducing this page to a short landing/redirect that links to the canonical quickstart, otherwise readers may land here via direct links and see instructions that drift out of sync over time.</comment>

<file context>
@@ -1,6 +1,6 @@
 # Getting Started
 
-> **New to altimate?** [Start with the 5-minute quickstart](quickstart.md) to go from install to your first analysis in minutes.
+> **New to Altimate Code?** [Start with the quickstart](getting-started/quickstart.md) to go from install to your first analysis.
 
 ## Why altimate?
</file context>


> **New to altimate?** [Start with the 5-minute quickstart](quickstart.md) to go from install to your first analysis in minutes.
> **New to Altimate Code?** [Start with the quickstart](getting-started/quickstart.md) to go from install to your first analysis.

@coderabbitai coderabbitai Bot Jul 23, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Make this page a landing page or remove it.

docs/docs/getting-started.md still contains a second full setup guide while docs/mkdocs.yml now makes docs/docs/getting-started/quickstart.md canonical. The two pages already diverge on configuration paths and mode commands, so direct links can expose stale instructions. Replace the duplicate body with a short redirect/landing page or remove it after checking inbound links.

🤖 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 `@docs/docs/getting-started.md` at line 3, Replace the duplicate setup-guide
content in getting-started.md with a concise landing page that directs readers
to getting-started/quickstart.md as the canonical guide, or remove the page
after verifying and updating inbound links. Do not retain conflicting
installation, configuration, or mode instructions.


## Why altimate?

Expand Down Expand Up @@ -140,12 +140,13 @@ altimate offers specialized agent modes for different workflows:
|---|---|
| Analyzing data without risk of changes | **Analyst** for read-only queries, cost analysis, data profiling. SQL writes are blocked entirely. |
| Building or generating dbt models | **Builder** for model scaffolding, SQL generation, ref() wiring. SQL writes prompt for approval. |
| Reviewing a change before it merges | **Reviewer** for grading SQL/dbt changes and returning an approve, comment, or request-changes verdict |
| Planning before acting | **Plan** for outlining an approach before switching to builder to execute it |

Switch modes in the TUI:

```
/mode analyst
```text title="In the TUI"
/agent analyst
```

## Step 5: Start Working
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ hide:

<p class="hero-actions" markdown>

[Get Started](quickstart.md){ .md-button .md-button--primary }
[Quickstart](quickstart.md){ .md-button .md-button--primary }
[See Examples](../examples/index.md){ .md-button }
[View on GitHub :material-github:](https://github.com/AltimateAI/altimate-code){ .md-button }

Expand Down
188 changes: 0 additions & 188 deletions docs/docs/getting-started/quickstart-new.md
View file
Open in desktop

This file was deleted.

Loading
Loading