Skip to content

Docs cleanup#2240

Merged
NoyaOffer merged 41 commits into
docsfrom
docs-cleanup
May 25, 2026
Merged

Docs cleanup#2240
NoyaOffer merged 41 commits into
docsfrom
docs-cleanup

Conversation

@NoyaOffer
Copy link
Copy Markdown
Contributor

No description provided.

NoyaOffer and others added 30 commits May 20, 2026 16:21
…ture

- Rename "Ella: AI Agents" → "Elementary AI Agent" throughout
- Remove all "Ella" references from agent pages; update titles to drop "AI Agent" suffix
- Add new Context Engine page explaining the knowledge layer powering the agent and MCP
- Restructure nav: AI Agent + Context Engine section leads, MCP moved up after it
- Replace "Anomaly Detection Monitors" + "Data Testing" with unified "Cloud Tests" section
- New Cloud Tests overview page: clear Cloud test vs. dbt test distinction
- Rename automated monitors to Cloud freshness test / Cloud volume test
- Rename "Collaboration & Communication" → "Data Catalog & Observability"
- Rename "Additional features" → "Config & Administration"
- Add redirects for all renamed/moved pages
- Rewrite cloud introduction to surface AI Agent + Context Engine upfront
- Add "Context Engine" badge to 38 integration pages + 9 feature pages
- Add "Elementary Cloud" badge to 28 Cloud-only feature and MCP pages

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Remove /cloud/ai-agents/overview self-redirect (was a no-op loop)
- Update home.mdx, snippets/cloud/features.mdx, changelog.mdx,
  monitors-configuration.mdx, data-contract-test.mdx, and
  start-using-elementary.mdx to point to new paths directly
- Mintlify redirects handle external/bookmark URLs; internal links
  now point to correct paths without relying on the redirect hop

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Context Engine: split "what it holds" into integration-fed vs
  Elementary-generated data (test results, model performance, usage
  stats, health scores) — reflects that it's everything Elementary
  knows about your stack, not just what integrations provide
- Fix "redundant assets" → "redundant tests that slow down the pipeline"
  in context-engine.mdx and agent overview card
- Update performance-cost-agent.mdx intro to lead with redundant tests
  and slow models, not just query optimization

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Context Engine:
- "it's healthy" → "its health status"
- Reframe intro as "connecting lineage across your stack"
- Move usage stats under DWH
- Remove "How it stays current" section
- Test results now specify dbt, Python and Cloud tests
- Add test performance

Cloud Tests:
- Cloud tests = freshness, volume, data contract only
- Add metrics to Cloud Tests section
- Move dbt tests + custom SQL to separate "dbt Tests" nav group
- Rewrite overview: config, agents, training period

Incidents:
- Merge incident-management content into incidents.mdx
- Remove incident-management from nav (redirect in place)
- Update all internal links pointing to incident-management
- Add AI Agent triage section

Governance:
- Rename sidebarTitle to "Governance best practices"
- Remove manage-metadata from nav (redirect to catalog)
- Merge metadata editing + governance agent card into catalog page

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Merge alert-configuration hub + alerts-configuration guide into owners-and-subscribers
  Renamed to "Alert configuration in code" with UI-first callout; removes redundant group wrapper
- Flatten Alerts & Incidents nav (remove "Setup & configure alerts" group)
- Consolidate Data Lineage section: remove semantic-layer sub-page
- Rewrite lineage overview: positions as Context Engine foundation, adds Python SDK + Fivetran sources, links to Context Engine page
- Move Snowflake Semantic Views to Integrations > Semantic Layer group
- Fix stale manage-metadata links in home.mdx, start-using-elementary.mdx, triage-and-response.mdx
- Add redirects for alert-configuration, alerts-configuration guide, semantic-layer old path

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Rename outer group Cloud Tests → Data Tests
- test-coverage-screen moves to top of Data Tests as entry point
- Cloud Tests and dbt Tests become sub-groups
- monitor-dwh-assets moves from Data Lineage → Cloud Tests sub-group; rewritten to drop dbt-only framing
- Merge monitors-configuration + monitors-feedback into cloud-tests-overview; remove both pages from nav
- dbt-tests: add opening about Elementary Cloud being built on dbt package
- Lineage overview: add DWH assets link alongside Fivetran sources
- Fix stale external links in detection-and-coverage.mdx
- Fix stale internal links in automated-monitors.mdx
- Add redirects: monitors-configuration → cloud-tests-overview, monitors-feedback → cloud-tests-overview

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…oss-refs

- Rename Data Observability → Data Health
- Move table-usage to Data Catalog & Governance
- Move multi-env to Transformation & Orchestration integrations group
- Remove table-usage and multi-env from Config & Administration
- Add cross-reference: governance page → critical assets
- Add cross-reference: critical assets page → governance best practices

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Split Transformation & Orchestration into three groups:
  dbt (core/cloud/fusion/multi-env + setup guides sub-group),
  Transformation (Cloud Python SDK — adds missing nav entry),
  Orchestration (airflow, tools, fivetran)
- Move dbt config guides (sync-scheduling, dev-prod, collect-job-data,
  collect-source-freshness, reduce-on-run-end-time, microbatch) into dbt > Setup guides
- Move onboarding guides into Getting Started
- Move troubleshoot into Config & Administration
- Remove Guides section entirely

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Pages remain accessible via quickstart flow links.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
dbt Fusion remains in beta.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- features.mdx: semantic-layer card → new integrations path
- alerts-configuration.mdx: alerts-configuration guide → owners-and-subscribers

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Updates the "Alerts configuration in code" card href from the old
guides path to the current owners-and-subscribers page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replaces old Detection/Triage/Collaboration sections with sections
that mirror the actual nav: AI Agent, Data Tests, Data Lineage,
Alerts & Incidents, Performance & Cost, Catalog & Governance, Data Health.
All card links verified against existing pages.

Also adds schema-validation-test to dbt Tests nav group so it's
reachable from both the features page and the sidebar.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
NoyaOffer and others added 11 commits May 24, 2026 18:04
All changes add a leading / to href values that were using relative
paths, ensuring links resolve correctly regardless of page depth.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The old onboarding step page /cloud/manage-team (Invite users) had no
redirect after being removed from the nav.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Remove "must be dbt user" callout (Python SDK is live)
- Fix broken step links: onboarding pages → current equivalents
- Fix invite step: manage-team → roles-and-permissions
- Fix step 4: enable-slack-alerts → integrations/alerts/slack
- Add set-up-elementary guide link in resources section
- Clean up title and intro framing

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- MCP Server: Setup subgroup (setup-guide, recommended-rules),
  mcp-tools and CI Code Review remain visible at top level
- dbt: rename Setup guides → dbt setup guides, move multi-env inside
- Remove icon from python-sdk/overview

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Fix broken /cloud/onboarding/quickstart-dbt-package links
  → /data-tests/dbt/quickstart-package
- Add Setup guides CardGroup to dbt core, cloud, and fusion pages
  pointing to sync-scheduling, dev-prod, multi-env, collect-job-data

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- quickstart-dbt-package → /data-tests/dbt/quickstart-package
- connect-data-warehouse → /cloud/integrations/elementary-integrations
- manage-team → /cloud/features/roles-and-permissions

Affected: postgres.mdx, clickhouse snippet, quick-start-cards snippet,
set-up-elementary guide.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Live pages: convert stale absolute URLs to correct relative links
- config-as-code: cloud/features/ai-agents → /cloud/ai-agents/overview
- config-as-code: cloud/features/mcp-server → /cloud/mcp/overview
- detection-and-coverage: /features/anomaly-detection/* → correct paths
- triage-and-response: /features/alerts-and-incidents/alert-rules → correct path

Redirects: add missing /features/* and /cloud/features/* short paths
so changelog links and bookmarks don't 404.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 25, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
elementary 🟡 Building May 25, 2026, 2:22 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 25, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 92ab6cd5-f8c4-4d2d-8a06-596075efb091

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-cleanup

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.

@NoyaOffer NoyaOffer merged commit 02939b1 into docs May 25, 2026
7 of 8 checks passed
@NoyaOffer NoyaOffer deleted the docs-cleanup branch May 25, 2026 14:22
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