Skip to content

Commit e05164d

Browse files
Docs: Language pass (#167)
## Description 📝 ## Quick Links 🚀 <!-- Links to the relevant place(s) in the CloudFlare Pages build. Wait for CF comment for link. --> ## Assertion Tests 🤖 <!-- Add assertions between the comments below to have ChatGPT check the quality of your docs contribution (Diff) and how well it integrates with existing docs. E.g., A user should be able to easily understand how to make a simple query. --> <!-- For more info, see the Action's docs in the marketplace: https://github.com/marketplace/actions/docs-assertion-tester#usage --> <!-- DX:Assertion-start --> <!-- DX:Assertion-end -->
1 parent 1c73f9b commit e05164d

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/capabilities.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ The AI functions extend these capabilities beyond pure data analysis:
6262
| Visualize | Create interactive data visualizations. |
6363

6464
By combining these primitives, PromptQL can tackle complex analytical tasks. For example, it might extract structured
65-
data from a batch of documents, classify the results, and visualize the patternsall in a single workflow. Or it could
65+
data from a batch of documents, classify the results, and visualize the patterns...all in a single workflow. Or it could
6666
summarize a large dataset, then extract key metrics from those summaries for deeper analysis.
6767

68-
These combinations aren't just powerfulthey're precise. Each primitive builds on the others, with error checking and
68+
These combinations aren't just powerful, they're precise. Each primitive builds on the others, with error checking and
6969
validation at every step. The result is reliable, reproducible analysis that can be turned into automated workflows.
7070

7171
:::info Learn more
@@ -100,15 +100,15 @@ When it comes to decision-making, PromptQL acts as your analytical partner. It c
100100
visualize trends, and run comparisons. Each analysis can be saved for future reference, shared with your team, or used
101101
as part of your audit trail.
102102

103-
The key is that PromptQL doesn't just show you numbersit helps you understand them. Ask it to explain its methodology,
103+
The key is that PromptQL doesn't just show you numbers: it helps you understand them. Ask it to explain its methodology,
104104
break down complex metrics, or look at the same data from different angles. It's built to clarify, not just calculate.
105105

106106
[Learn more](/decision-making.mdx) about making decisions with PromptQL.
107107

108108
### Automate tasks
109109

110110
Once you've found a valuable analysis pattern, PromptQL can turn it into a reliable automation. These aren't just saved
111-
queries—they're full workflows that can process new data, generate reports, monitor metrics, or alert on conditions.
111+
queries, but full workflows that can process new data, generate reports, monitor metrics, or alert on conditions.
112112

113113
Each automation comes with built-in error handling and can be parameterized to handle different inputs. Chain them
114114
together for more complex operations, or schedule them to run regularly. The goal is to turn your one-off analyses into

docs/decision-making.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import Thumbnail from "@site/src/components/Thumbnail";
1818

1919
**Decision making** with PromptQL supports deeper analysis and structured exploration across your data. You can ask
2020
complex, layered questions and get responses that adapt to your systems and terminology. PromptQL helps you drill into
21-
root causes, compare across categories, and evaluate tradeoffswithout being limited by context windows or informal
21+
root causes, compare across categories, and evaluate tradeoffs without being limited by context windows or informal
2222
language.
2323

2424
This is useful for scenarios that require exploration and judgment, such as:
@@ -29,19 +29,19 @@ This is useful for scenarios that require exploration and judgment, such as:
2929

3030
## Guides
3131

32-
Below, we've split out a few different use cases as examples. You can run these against the
33-
[public sandbox-quickstart project](https://promptql.console.hasura.io/public/sandbox-movie-studio/playground).
32+
Below, we've split out a few different use cases as examples. You can run these against the `sandbox-movie-studio`
33+
[project](https://promptql.console.hasura.io/public/sandbox-movie-studio/playground).
3434

3535
### Q&A
3636

37-
It would seem that asking questions about data is simple, but this is difficult because business terms often map to
38-
multiple systems or concepts. For example, "performance" might refer to revenue, engagement, or critical ratings,
39-
depending on who’s asking. Systems don’t always agree on how those values are calculated, either.
40-
4137
Take this example:
4238

4339
> _How did our PG-13 portfolio perform against R-rated titles during the streaming transition period?_
4440
41+
It would seem that asking questions about data is simple, but this is difficult because business terms often map to
42+
multiple systems or concepts. For example, "performance" might refer to revenue, engagement, or critical ratings,
43+
depending on who’s asking. Systems don’t always agree on how those values are calculated, either.
44+
4545
PromptQL solves this by mapping ambiguous terms to precise system definitions and building a plan that retrieves data
4646
from the right sources in the correct form. The generated plan accounts for relevant time windows, content ratings, and
4747
distribution channels, producing a structured answer tailored to your domain.
@@ -84,8 +84,8 @@ patterns across time or categories.
8484

8585
> _Can you analyze the ROI patterns of our genre-blending titles compared to pure-genre releases between 2010–2020?_
8686
87-
PromptQL is unique because it treats research as a processnot just a query. It generates a plan that defines discovery
88-
phases, collects and segments relevant data, and evaluates each hypothesis systematically.
87+
PromptQL is unique because it treats research as a process and not just a query. It generates a plan that defines
88+
discovery phases, collects and segments relevant data, and evaluates each hypothesis systematically.
8989

9090
<Thumbnail src="/img/get-started/playground-deep-research.png" alt="Details of a deployed automation." />
9191

docs/how-to-talk-to-promptql.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ shaping how PromptQL thinks about your business, your data, and your language.
2424
## Do's
2525

2626
PromptQL works best when you treat it like a collaborator. Ask specific questions in natural language. There's no need
27-
to speak in SQL or use exact technical phrases—just describe what you’re curious about.
27+
to speak in SQL or use exact technical phrases. Just describe what you’re curious about.
2828

2929
Examples:
3030

@@ -34,7 +34,7 @@ Show me churn by region.
3434
Break this down by customer type.
3535
```
3636

37-
It helps to add contextespecially for company-specific terms, business rules, or timeframes. PromptQL will do its best
37+
It helps to add context, especially for company-specific terms, business rules, or timeframes. PromptQL will do its best
3838
to infer meaning, but your clarification speeds things up and improves accuracy.
3939

4040
As you go, don’t hold back feedback. If an answer is off, say so. Corrections make it smarter. You can say:
@@ -57,7 +57,7 @@ Show a chart of the trend.
5757
Group by location and limit to the top 10.
5858
```
5959

60-
If you're unsure about terminology, just ask. PromptQL can define terms or explain metrics—it’s built to clarify, not
60+
If you're unsure about terminology, just ask. PromptQL can define terms or explain metrics. It’s built to clarify, not
6161
confuse.
6262

6363
## Don'ts

0 commit comments

Comments
 (0)