Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
File renamed without changes
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
docs:
- changed-files:
- any-glob-to-any-file: docs/*
- any-glob-to-any-file: docs-mintlify/**/*

# Data source drivers
data source driver:
Expand Down
1 change: 0 additions & 1 deletion .oxlintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
"coverage/",
"gen/",
"**/*.d.ts",
"docs/",
"docs-mintlify/",
"examples/",
"rust/cubesql/",
Expand Down
11 changes: 4 additions & 7 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,8 @@ yarn test

### Documentation Development

**IMPORTANT: `/docs-mintlify` is the active documentation site. `/docs` is the legacy
docs site and is deprecated — do NOT add or edit content there.** When asked to write or
update documentation, work in `/docs-mintlify` unless the user explicitly says otherwise.
Documentation lives in `/docs-mintlify`. When asked to write or update documentation,
work there unless the user explicitly says otherwise.

```bash
cd docs-mintlify
Expand All @@ -82,8 +81,7 @@ yarn dev # Start the Mintlify dev server
- Database drivers: `cubejs-postgres-driver`, `cubejs-bigquery-driver`, etc.
- API layer: `cubejs-api-gateway`
- **`/rust`**: Rust components including CubeSQL (SQL interface) and CubeStore (distributed storage)
- **`/docs-mintlify`**: Mintlify documentation site — **the active docs site** (author docs here)
- **`/docs`**: Legacy Next.js/Nextra documentation site — **deprecated**, do not edit
- **`/docs-mintlify`**: Mintlify documentation site
- **`/examples`**: Example implementations and recipes

### Key Components
Expand Down Expand Up @@ -150,8 +148,7 @@ Include scope in parentheses when applicable, e.g., `fix(tesseract):` or `feat(d

## Important Notes

- Documentation lives in `/docs-mintlify` (active, Mintlify). `/docs` is the legacy docs
site and is deprecated — do not add or edit content there. See `docs-mintlify/CLAUDE.md`.
- Documentation lives in `/docs-mintlify` (Mintlify). See `docs-mintlify/CLAUDE.md`.
- The main Cube application development happens in `/packages`
- For data model changes, focus on `cubejs-schema-compiler` package
- For query execution changes, focus on `cubejs-query-orchestrator` package
Expand Down
1 change: 0 additions & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
/packages/*-schema-extension/ @cube-js/schema-compiler

# Doc reviewers
/docs/ @cube-js/doc-reviewers
/docs-mintlify/ @keydunov

# Developer Relations and Community
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ By contributing to Cube Dev, Inc., You accept and agree to the terms and conditi
3. Clone the [Cube repo](https://github.com/cube-js/cube).
4. Submit your Pull Request.
5. Testing: Please include test(s) for your code contribution. Depending on a change it can be tested by unit, integration or E2E test. See some of the test examples for [drivers](https://github.com/cube-js/cube/pull/1333/commits/56dadccd62ac4eaceafe650d2853406f5d3d9d43) and [backend](https://github.com/cube-js/cube/tree/master/packages/cubejs-backend-shared/test). There're separate packages for [E2E testing](https://github.com/cube-js/cube/tree/master/packages/cubejs-testing/) and [E2E driver testing](https://github.com/cube-js/cube/tree/master/packages/cubejs-testing-drivers/). **Tests are required for most of the contributions.**
6. Documentation: When new features are added or there are changes to existing features that require updates to documentation, we encourage you to add/update any missing documentation in the [`/docs` folder](https://github.com/cube-js/cube/tree/master/docs). To update an existing documentation page, you can simply click on the `Edit this page` button on the top right corner of the documentation page.
6. Documentation: When new features are added or there are changes to existing features that require updates to documentation, we encourage you to add/update any missing documentation in the [`/docs-mintlify` folder](https://github.com/cube-js/cube/tree/master/docs-mintlify).
7. Relevant team(s) will be pinged automatically for a review based on information in the `CODEOWNERS` file.

## Development Workflow
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://cube.dev?ref=github-readme"><img src="https://raw.githubusercontent.com/cube-js/cube/master/docs/content/cube-core-logo.png" alt="Cube Core — Open-Source Semantic Layer" width="300px"></a>
<a href="https://cube.dev?ref=github-readme"><img src="https://raw.githubusercontent.com/cube-js/cube/master/.github/assets/cube-core-logo.png" alt="Cube Core — Open-Source Semantic Layer" width="300px"></a>
</p>
Comment on lines +2 to 3

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.

Minor: these URLs hardcode /master/, so both hero images render broken on this branch (and in the PR's own README preview) until the commit reaches master — the old path is gone and the new one isn't on master yet. Self-resolving on merge, so not a blocker.

Since the assets now live in this repo rather than being cross-referenced, relative paths would sidestep the branch pin entirely and survive future moves:

Suggested change
<a href="https://cube.dev?ref=github-readme"><img src="https://raw.githubusercontent.com/cube-js/cube/master/.github/assets/cube-core-logo.png" alt="Cube Core — Open-Source Semantic Layer" width="300px"></a>
</p>
<p align="center">
<a href="https://cube.dev?ref=github-readme"><img src=".github/assets/cube-core-logo.png" width="300px"></a>
</p>

One caveat if you take this: relative image paths only resolve where the README is rendered alongside the repo (GitHub, and it stays correct across branches/forks). This root README.md isn't published to npm — the client packages ship their own — so there's no registry-rendering regression, but it's the reason the absolute form was probably chosen originally. Your call; the absolute form is correct as written.

<br/>

Expand All @@ -14,7 +14,7 @@ __Cube Core is the open-source semantic layer.__ Define metrics, dimensions, joi
Cube Core works with all SQL data sources, including cloud data warehouses like Snowflake, Databricks, and BigQuery; query engines like Presto and Amazon Athena; and application databases like Postgres. It has a built-in relational caching engine to provide sub-second latency and high concurrency for API requests.

<img
src="https://raw.githubusercontent.com/cube-js/cube/master/docs/content/cube-core-schema.png"
src="https://raw.githubusercontent.com/cube-js/cube/master/.github/assets/cube-core-schema.png"
alt="Cube Core — semantic layer connecting data sources to embedded analytics, BI tools, and AI agents"
style="border: none"
width="100%"
Expand Down
5 changes: 1 addition & 4 deletions docs-mintlify/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# Cube Documentation (Mintlify)

This is the **active** Cube documentation site, built with [Mintlify](https://mintlify.com).
The Cube documentation site, built with [Mintlify](https://mintlify.com).
All documentation work should happen here.

> The `/docs` directory at the repo root is the **legacy** Nextra docs site and is
> **deprecated** — do not add or edit content there.

## Local development

```bash
Expand Down
Loading
Loading