Skip to content

Commit ad659b1

Browse files
authored
docs: update cursor rules with product taxonomy and documentation guidance (cube-js#10675)
Add product taxonomy to naming conventions rule and set it to always apply for docs-mintlify files. Add new writing-documentation rule with guidance on researching the cloud product codebase and Mintlify best practices. Made-with: Cursor
1 parent 2812644 commit ad659b1

2 files changed

Lines changed: 36 additions & 2 deletions

File tree

.cursor/rules/namings-rule.mdc

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
description: Product naming conventions for Cube documentation
32
globs: docs-mintlify/**
4-
alwaysApply: false
3+
alwaysApply: true
54
---
65

76
# Product Naming Conventions
@@ -16,3 +15,29 @@ alwaysApply: false
1615
- **Development** — development deployment type (legacy: "Development instance")
1716
- **Production** — production deployment type (legacy: "Production cluster")
1817
- **Multi-cluster** — multi-cluster production deployment type (legacy: "Production multi-cluster")
18+
19+
# Product Taxonomy
20+
Make sure to use correct terms.
21+
22+
- **Account**
23+
- **Deployment**
24+
- **Analytics Chat**
25+
- **Workbook**
26+
- Tab
27+
- Dashboard builder
28+
- **Dashboard**
29+
- Scheduled refresh
30+
- **Semantic Model**
31+
- Semantic Model IDE (short: "IDE")
32+
- Semantic Model Agent
33+
- **Explore**
34+
- Explorations
35+
- **API**
36+
- Embed APIs
37+
- Core Data APIs
38+
- Management APIs
39+
- Orchestration API
40+
- **Embedding**
41+
- Private embedding
42+
- Signed embedding
43+
- Creator Mode
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
alwaysApply: true
3+
globs: docs-mintlify/**
4+
---
5+
6+
This repo only contains code for Cube Core and documentation.
7+
Our cloud product codebase is located in ~/code/cubejs-enterprise (at least that is where it is located on Artyom's mac). Research the cloud product codebase when documenting new features.
8+
Our documenation is built with https://www.mintlify.com. Make sure you follow Mintlify best practices when designing documentation.
9+
Our competitors are [Omni](https://omni.co/) and [Hex](https://hex.tech/). We use their documentation sometimes as a reference.

0 commit comments

Comments
 (0)