docs: sync missing content from v2 and rename What's New to Changelog#284
Merged
arora-saurabh448 merged 15 commits intomainfrom Mar 19, 2026
Merged
docs: sync missing content from v2 and rename What's New to Changelog#284arora-saurabh448 merged 15 commits intomainfrom
arora-saurabh448 merged 15 commits intomainfrom
Conversation
- Standardize tool count to 50+ across all docs (was 99+/55+) - Update install command to unscoped `altimate-code` package - Remove stale Python/uv auto-setup claims (all-native TypeScript now) - Update docs badge URL to docs.altimate.sh - Remove altimate-core npm badge from README - Add --yolo flag to CLI reference and builder mode subtext - Add new env vars (YOLO, MEMORY, TRAINING) to CLI docs - Add prompt enhancement keybind (leader+i) to TUI and keybinds docs - Add tool_lookup to tools index - Add built-in skills table (sql-review, schema-migration, pii-audit, etc.) - Add altimate-dbt CLI section to dbt-tools.md - Add Oracle and SQLite to warehouse lists - Update security FAQ: replace Python engine FAQ with native engine, add sensitive_write FAQ - Update telemetry docs to remove Python engine references - Add v0.4.2 to README "What's New" section - Update llms.txt URLs to docs.altimate.sh and bump version to v0.4.2 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Replace 304 em-dashes across 38 docs files with natural sentence structures (colons, commas, periods, split sentences) to avoid AI-generated content appearance - Fix pill-grid CSS: increase gap/padding, add responsive breakpoints at 768px and 480px for reliable scaling across viewport sizes - Simplify quickstart /discover step to brief description + link to Full Setup; add (Optional) marker to getting-started warehouse step Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Rewrite quickstart as a full Setup page covering warehouse connections, LLM provider switching, agent modes, skills, and permissions. Update overview page with ADE-Bench results (74.4%), fix install command, and change 70+ to 50+ tools. Replace query example with NYC taxi cab analytics prompt. Remove time blocks from step headings and trim redundant sections. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move CI page from data-engineering/guides to usage/. Remove duplicate non-interactive and tracing sections from CLI page, link to CI instead. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove data-engineering-specific agent table from agents.md (now covered elsewhere), replace grid cards in quickstart with a compact link list, and rename "Complete Setup" → "Setup" in nav. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Rename "What's New" to "Changelog" across docs, nav, and README - Populate changelog with full release history (v0.1.0 through v0.4.9) - Add inline permission examples to security-faq (permission table, JSON configs) - Add Data Engineering agents table and Agent Permissions example to agents page - Add Non-interactive Usage and Tracing sections to CLI docs - Add missing nav entries: Web UI, Claude Code/Codex guides, Memory Tools, Observability (Tracing/Telemetry), Training, and Extend (SDK/Server/Plugins/Ecosystem) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Updates and reorganizes the documentation to reflect the current docs site structure, expand missing content synced from v2, and rename “What’s New” to “Changelog”.
Changes:
- Restructures MkDocs navigation and adds multiple missing reference/configuration pages.
- Adds/updates docs content across CLI usage, governance/security, telemetry/tracing, and data-engineering tool references.
- Renames/aligns branding and marketing copy (e.g., “50+ tools”), updates install/package references, and refreshes examples.
Reviewed changes
Copilot reviewed 57 out of 58 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/mkdocs.yml | Reorganizes site nav and reference locations |
| docs/docs/usage/web.md | Clarifies web config table defaults |
| docs/docs/usage/tui.md | Updates TUI descriptions and keybind list |
| docs/docs/usage/cli.md | Adds --yolo, env var sections, tracing info |
| docs/docs/usage/ci-headless.md | Adds headless/CI usage page |
| docs/docs/reference/windows-wsl.md | Updates Windows install + wording tweaks |
| docs/docs/reference/troubleshooting.md | Wording/formatting and link updates |
| docs/docs/reference/telemetry.md | Updates event descriptions and links |
| docs/docs/reference/security-faq.md | Expands security/permissions guidance + engine update |
| docs/docs/reference/network.md | Adds network/proxy/firewall reference page |
| docs/docs/reference/changelog.md | Adds full changelog page content |
| docs/docs/quickstart.md | Updates quickstart copy and formatting |
| docs/docs/llms.txt | Updates docs index metadata and URLs |
| docs/docs/index.md | Updates homepage copy + supported DB list |
| docs/docs/getting-started/quickstart.md | Adds expanded setup guide page |
| docs/docs/getting-started/quickstart-new.md | Adds “10-minute” quickstart page |
| docs/docs/getting-started/index.md | Adds “Getting Started” landing page |
| docs/docs/getting-started.md | Updates full setup guide copy |
| docs/docs/examples/index.md | Adds examples showcase landing page |
| docs/docs/drivers.md | Updates driver docs wording/formatting |
| docs/docs/develop/server.md | Formatting updates to server endpoint list |
| docs/docs/develop/sdk.md | Formatting updates to SDK import table |
| docs/docs/develop/plugins.md | Formatting updates + clarifies hook behavior |
| docs/docs/develop/ecosystem.md | Formatting updates to integrations/community |
| docs/docs/data-engineering/training/team-deployment.md | Improves clarity and heading formatting |
| docs/docs/data-engineering/training/index.md | Improves wording + examples formatting |
| docs/docs/data-engineering/tools/warehouse-tools.md | Removes outdated Python engine snippet |
| docs/docs/data-engineering/tools/sql-tools.md | Formatting consistency improvements |
| docs/docs/data-engineering/tools/schema-tools.md | Formatting consistency improvements |
| docs/docs/data-engineering/tools/memory-tools.md | Formatting consistency improvements |
| docs/docs/data-engineering/tools/index.md | Updates tool-count copy + adds tool_lookup |
| docs/docs/data-engineering/tools/finops-tools.md | Formatting consistency improvements |
| docs/docs/data-engineering/tools/dbt-tools.md | Adds altimate-dbt CLI section |
| docs/docs/data-engineering/guides/using-with-codex.md | Minor wording update |
| docs/docs/data-engineering/guides/migration.md | Reformats best-practices list |
| docs/docs/data-engineering/guides/cost-optimization.md | Reformats list items |
| docs/docs/data-engineering/guides/ci-headless.md | Updates install command + link paths |
| docs/docs/data-engineering/agent-modes.md | Adds --yolo tip + formatting |
| docs/docs/configure/warehouses.md | Adds warehouses configuration reference |
| docs/docs/configure/tracing.md | Refines tracing docs and links |
| docs/docs/configure/tools/index.md | Adds tools reference index page |
| docs/docs/configure/tools/custom.md | Adds custom tools documentation |
| docs/docs/configure/tools/core-tools.md | Adds core tool catalog page |
| docs/docs/configure/tools/config.md | Adds built-in tool list page |
| docs/docs/configure/tools.md | Updates tool count + wording |
| docs/docs/configure/skills.md | Adds built-in skills table |
| docs/docs/configure/rules.md | Formatting and wording improvements |
| docs/docs/configure/providers.md | Minor wording improvements |
| docs/docs/configure/permissions.md | Wording + formatting improvements |
| docs/docs/configure/keybinds.md | Adds prompt enhancement keybind |
| docs/docs/configure/index.md | Adds configuration landing page |
| docs/docs/configure/governance.md | Adds governance overview page |
| docs/docs/configure/context-management.md | Formatting and clarity improvements |
| docs/docs/configure/config.md | Fixes telemetry link + table defaults |
| docs/docs/configure/commands.md | Formatting improvements |
| docs/docs/configure/agents.md | Wording improvements |
| docs/docs/assets/css/extra.css | Adjusts card/pill grid spacing and responsiveness |
| README.md | Updates package/docs links and renames section to Changelog |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/docs/quickstart.md
Outdated
| ``` | ||
|
|
||
| `/discover` scans for dbt projects, warehouse credentials (from `~/.dbt/profiles.yml`, environment variables, and Docker), and installed tools. It **reads but never writes** — safe to run against production. | ||
| Auto-detects your dbt projects, warehouse credentials, and installed tools. See [Full Setup](getting-started.md#step-3-configure-your-warehouse) for details on what `/discover` finds and manual configuration options. |
Collaborator
There was a problem hiding this comment.
Resolved / Not Applicable. The link in quickstart.md line 63 is already getting-started.md#step-3-configure-your-warehouse-optional, which matches the heading in getting-started.md. This was likely fixed in a subsequent commit.
docs/docs/llms.txt
Outdated
Comment on lines
+10
to
+12
| - [Quickstart (5 min)](https://docs.altimate.sh/quickstart/): Install altimate, configure your LLM provider, connect your warehouse, and run your first query in under 5 minutes. | ||
| - [Full Setup Guide](https://docs.altimate.sh/getting-started/): Complete installation, warehouse configuration for all 8 supported warehouses, LLM provider setup, and first-run walkthrough. | ||
| - [Network & Proxy](https://docs.altimate.sh/network/): Proxy configuration, CA certificate setup, firewall requirements. |
Collaborator
There was a problem hiding this comment.
Valid — still open. Confirmed: network.md is at reference/network.md per mkdocs.yml nav, so the URL should be https://docs.altimate.sh/reference/network/ not https://docs.altimate.sh/network/.
docs/docs/llms.txt
Outdated
Comment on lines
+39
to
+42
| ## Reference | ||
|
|
||
| - [Security FAQ](https://altimateai.github.io/altimate-code/security-faq/): 12 Q&A pairs on data handling, credentials, permissions, network endpoints, and team hardening. | ||
| - [Troubleshooting](https://altimateai.github.io/altimate-code/troubleshooting/): 6 common issues with step-by-step fixes, including Python bridge failures and warehouse connection errors. | ||
| - [Security FAQ](https://docs.altimate.sh/security-faq/): 12 Q&A pairs on data handling, credentials, permissions, network endpoints, and team hardening. | ||
| - [Troubleshooting](https://docs.altimate.sh/troubleshooting/): 6 common issues with step-by-step fixes, including tool execution errors and warehouse connection setup. |
Collaborator
There was a problem hiding this comment.
Valid — still open. Confirmed: both security-faq.md and troubleshooting.md are under reference/ in mkdocs.yml nav. URLs should be /reference/security-faq/ and /reference/troubleshooting/.
docs/docs/llms.txt
Outdated
Comment on lines
+36
to
+37
| - [Tracing](https://docs.altimate.sh/configure/tracing/): Local-first observability covering trace schema, span types, live viewing, remote OTLP exporters, and crash recovery. | ||
| - [Telemetry](https://docs.altimate.sh/configure/telemetry/): 25 anonymized event types, privacy guarantees, opt-out instructions. |
Collaborator
There was a problem hiding this comment.
Valid — still open. Confirmed: telemetry is at reference/telemetry.md in mkdocs.yml nav, so the URL should be https://docs.altimate.sh/reference/telemetry/ not /configure/telemetry/.
Comment on lines
+16
to
+18
| ```bash | ||
| npm update -g @altimateai/altimate-code | ||
| ``` |
Collaborator
There was a problem hiding this comment.
Not Applicable. The upgrade command on line 17 is npm update -g altimate-code (unscoped), which matches the install command used throughout the docs and README. The scoped name @altimateai/altimate-code is not present here — this comment appears to have been generated against an earlier revision of the diff.
docs/docs/reference/changelog.md
Outdated
Comment on lines
+44
to
+46
| ## [0.4.1] - 2026-03-16 | ||
| ## [0.4.2] - 2026-03-18 | ||
|
|
Collaborator
There was a problem hiding this comment.
Partially Not Applicable. The versions are in correct descending order (0.4.9 → 0.4.2 → 0.4.1 → 0.4.0 → ...) and 0.4.1 does have content (lines 79–98: tracing system, engine fixes, bridge fixes). The gaps (0.4.3–0.4.8) likely represent versions that were never released publicly.
However, one valid concern: v0.5.0 is missing from the changelog — it is the latest release per git history but has no entry here. That should be added.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Collaborator
Docs Build Review
Broken Anchor Links
Bugs
Inconsistent Tool Counts
Orphaned Pages (in docs/ but not in nav)9 pages exist on disk but are missing from the
Duplicate PagesThree pairs of near-duplicate pages exist (old + new) where the old copy was not removed:
Warehouse Count Mismatch
|
- Fix broken anchor link to #step-3-configure-your-warehouse-optional - Add inline "Adding Custom Skills" section in skills.md - Fix changelog upgrade command to use unscoped package name - Split merged 0.4.1/0.4.2 changelog into separate sections - Update tool count from 70+ to 100+ in configure/tools pages - Move Guides to bottom of Use section in nav - Change hero tagline to "Open-source data engineering harness." - Simplify install command to just npm install Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
… stub web UI - Reduce agent modes from 7 to 3 (builder, analyst, plan) per PR #282 - Add SQL Write Access Control section with query classification table - Add sql_execute_write permission to permissions reference - Update /data to /altimate in Claude Code guide, add /configure-claude setup - Add Codex CLI skill integration and /configure-codex setup - Add /configure-claude and /configure-codex to commands reference - Stub web UI page with Coming Soon notice - Update all cross-references (getting-started, quickstart, index, tui, training, migration) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- commands.md: keep capitalized "Integration" heading - cli.md: keep --yolo flag in global flags table Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Collaborator
arora-saurabh448
left a comment
arora-saurabh448
left a comment
There was a problem hiding this comment.
Review Summary
Reviewed all 6 Copilot comments and the overall PR (58 files, +2942/-894).
Copilot Comment Triage
| # | File | Status | Reason |
|---|---|---|---|
| 1 | quickstart.md — anchor link |
Resolved | Link already updated to #step-3-configure-your-warehouse-optional in a later commit |
| 2 | llms.txt line 12 — /network/ URL |
Valid | Should be /reference/network/ per mkdocs.yml nav |
| 3 | llms.txt line 42 — /security-faq/, /troubleshooting/ URLs |
Valid | Should be /reference/security-faq/ and /reference/troubleshooting/ |
| 4 | llms.txt line 37 — /configure/telemetry/ URL |
Valid | Should be /reference/telemetry/ |
| 5 | changelog.md line 18 — scoped package name |
Not Applicable | Current code uses altimate-code (unscoped), which is correct |
| 6 | changelog.md — ordering/content |
Partially N/A | Versions are in correct descending order and 0.4.1 has content. But v0.5.0 is missing from the changelog |
Additional Findings
-
llms.txt— inconsistent tool count: The description says "50+ tools" but the rest of the docs (quickstart, index, getting-started) say "100+ tools". Should be aligned. -
llms.txt— stale version: Header saysVersion: v0.4.2but latest release isv0.5.0. -
Changelog missing v0.5.0: The latest release (
release: v0.5.0per git log) has no entry inreference/changelog.md. -
Nav file integrity: All 57 nav entries in
mkdocs.ymlresolve to existing.mdfiles — no missing pages. -
Internal markdown links: All relative links in the changed files resolve correctly — no broken internal links.
Open Items (3 fixes needed)
- Fix 4 stale URLs in
llms.txt(network, telemetry, security-faq, troubleshooting) - Add v0.5.0 entry to
reference/changelog.md - Align tool count in
llms.txtdescription ("50+" → "100+") to match rest of docs
- Fix 4 broken URLs in llms.txt (network, telemetry, security-faq, troubleshooting) to match reference/ paths in mkdocs nav - Update llms.txt version from v0.4.2 to v0.5.0 - Add missing v0.5.0 changelog entry with features and fixes Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Collaborator
|
Pushed llms.txt:
changelog.md:
All 6 Copilot comments are now addressed. |
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughThis PR comprehensively updates Altimate Code documentation and marketing copy. Key changes include: updating tool count from 99+ to 100+, renaming the npm package from Changes
Poem
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip You can customize the tone of the review comments and chat replies.Configure the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
mkdocs build)🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes
New Features
npm install -g altimate-code--yoloflag to auto-approve permission promptsAgent Modes
Documentation