docs: remove AI-sounding style (em dashes, emojis, marketing tone, ba… · deepnote/deepnote@764f602 · GitHub
Skip to content

Commit 764f602

Browse files
Haleshottkislan
andauthored
docs: remove AI-sounding style (em dashes, emojis, marketing tone, bare URLs) (#502)
* docs: simplify big number block introduction Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up bigquery-oauth prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up billing-alerts-and-limits prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up chart-blocks prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up conda-environment prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up converting-notebooks prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up custom-environment prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: replace en dash in data app guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: rewrite data catalog guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from dbt Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up deepnote-agent prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up deepnote-ai prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up deepnote-file-sync prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up deepnote-first-steps prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up deepnote-mcp prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from deploying-machine-learning-models Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from deprecating-personal-workspaces Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: replace double hyphen in Docker Hub guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up edu-overview prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: rewrite ETL and ELT pipeline guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up export-pdf prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: tighten getting started copy Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up git-export prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from google-drive Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up history prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: tighten docs landing page Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up individual-assignments prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up input-blocks prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from integrations Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up ipywidgets-in-deepnote prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove emoji from shortcut headings Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: label URL Encoder link Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up lectures prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from local setup Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up long-running-jobs prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove emoji from conversion lists Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up modules prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove emoji from notebook headings Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up pricing prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up projects prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from real-time-collaboration Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up run-snapshots prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up scheduling prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up securing-connections prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: rewrite security overview Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: replace en dash in sharing guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up snowflake-oauth prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up snowflake-with-azure-ad prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up snowflake-with-okta prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up snowpark prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: replace en dash in support guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: tighten teacher guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: replace en dash in permissions guide Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up telegram prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up text-editing prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: remove decorative emoji from training-machine-learning-models Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clean up workspaces prose Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: fix review copy edits and heading levels Correct typos and the snapshot count, keep shortcut sections as H2 siblings, and use a neutral example introduction. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clarify package sources, ELT loading, and AI context Link conda channels and the Snowpark write example. Match the AI overview to the documented notebook context and output setting. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: align AI context and security with privacy guidance Clarify notebook context and output sharing. Remove unsupported provider agreement and customer-owned storage claims, and name the admin control. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: replace audience claims with help and demo copy Keep the support email and embedded video while removing audience counts and customer claims. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: clarify security report and legacy file sync wording Use SOC 2 report terminology, state the Enterprise SSO requirement, and label bundled file sync as legacy. Remove the remaining em dashes from the sync page. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: include SAML in the security overview Match the SSO protocol list to the SSO documentation. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: restore useful table icons and integrations emoji Keep compatibility icons alongside their text labels and preserve the integrations description. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> * docs: use icons alone in local setup comparison Remove redundant Yes and No labels from the execution and editing cells. Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> --------- Signed-off-by: Srihari Thyagarajan <hari.leo03@gmail.com> Co-authored-by: Tomas Kislan <tomas@kislan.sk>
1 parent 7c1d02f commit 764f602

56 files changed

Lines changed: 256 additions & 352 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/big-number-blocks.md‎

Lines changed: 2 additions & 2 deletions

‎docs/bigquery-oauth.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To set up authentication to BigQuery via OAuth, navigate to the [Google Cloud co
3737
7. Click **Create**
3838
8. From the newly created Client, copy `CLIENT_ID` and `CLIENT_SECRET`
3939

40-
👉 Now head back to Deepnote and add the Client ID, Client Secret, and Project ID to the Google Big Query integration pop up. You will of course need to make sure you've selected Google OAuth as the authentication method.
40+
Now head back to Deepnote and add the Client ID, Client Secret, and Project ID to the Google Big Query integration pop up. You will of course need to make sure you've selected Google OAuth as the authentication method.
4141
![gbq_oauth_fill.png](../assets/docs/nStDWWqlQgGp73sYYZ6Y.webp)
4242

4343
### Querying data with user-specific authentication
@@ -54,5 +54,5 @@ When you create an app from a notebook that uses the integration, every app user
5454

5555
<Callout status="info">
5656
- User authentication is also required to browse the BigQuery schema.
57-
- Scheduled notebooks can use a BigQuery OAuth integration: scheduled runs authenticate with the OAuth tokens of the user who set up the schedule. Because those tokens can expire or be revoked, scheduled runs may fail unexpectedly — for reliable scheduling, use [service account authentication](google-bigquery#authenticating-with-a-service-account) instead.
57+
- Scheduled notebooks can use a BigQuery OAuth integration: scheduled runs authenticate with the OAuth tokens of the user who set up the schedule. Those tokens can expire or be revoked. For reliable scheduling, use [service account authentication](google-bigquery#authenticating-with-a-service-account) instead.
5858
</Callout>

‎docs/billing-alerts-and-limits.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ If you need to make sure to stay in your budget, you can choose to disable the p
2525
- Stop any running projects with stronger machine settings, and change them to use Basic machines on the next start
2626
- Disable the options for pay-as-you-go machines in the project settings
2727

28-
Be careful – enabling the option may interrupt the work of your colleagues.
28+
Be careful because enabling the option may interrupt your colleagues' work.
2929

3030
### Setting billing limits
3131

32-
If you want to set a limit for your charges, we recommend you set a billing alert for that amount. When you receive the notification, you can follow the link the email and disable the pay-as-you-go machines in your workspace.
32+
If you want to set a limit for your charges, we recommend you set a billing alert for that amount. When you receive the notification, you can follow the link in the email and disable the pay-as-you-go machines in your workspace.
3333

3434
## AI usage limits
3535

36-
AI usage is billed on a usage basis. Each plan includes a monthly AI quota, and usage beyond it is billed as pay-as-you-go. To keep AI spending predictable, workspace admins can set a custom monthly overage limit in the workspace settings, and will receive emails as usage approaches or exceeds the included quota. Admins can also review AI usage — token consumption and cost per user and across the workspace — in the workspace settings.
36+
AI usage is billed on a usage basis. Each plan includes a monthly AI quota, and usage beyond it is billed as pay-as-you-go. To keep AI spending predictable, workspace admins can set a custom monthly overage limit in the workspace settings, and will receive emails as usage approaches or exceeds the included quota. Admins can also review token consumption and cost per user or across the workspace in the workspace settings.

‎docs/chart-blocks.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ Depending on chart type and data type, there are couple of additional settings t
5757

5858
Depending on the chart type, you might be able to manually change the data type of selected column. Deepnote supports 3 data types.
5959

60-
- Nominal — categorical data without a specific order among values. For example, product categories in sales report.
60+
- Nominal: Categorical data without a specific order among values. For example, product categories in a sales report.
6161

62-
- Temporal — data related to time and dates. Following our sales report example, order date will have temporal data type.
62+
- Temporal: Data related to time and dates. In the sales report example, the order date has a temporal data type.
6363

64-
- Quantitative — numerical data that can be measured and analyzed mathematically, e.g. product prices or store's revenue.
64+
- Quantitative: Numerical data that you can measure and analyze mathematically, e.g. product prices or store revenue.
6565

6666
### Aggregation
6767

@@ -111,7 +111,7 @@ You can also apply **conditional filters** on your charts, giving you more preci
111111

112112
<VideoLoop src="../assets/docs/p7WogC9QmqIYj1exF9VQ.mp4" />
113113

114-
Applied filters are always added to the Filters list, making them easy to remove or modify. You can also combine multiple conditional filters — just press the plus button in the Filters list to add a new filter for more complex filtering logic.
114+
Applied filters appear in the Filters list, where you can remove or modify them. To combine conditional filters, press the plus button in the Filters list and add another filter.
115115

116116
<VideoLoop src="../assets/docs/oQd8gnR22ohfu3Q2hBqw.mp4" />
117117

@@ -131,7 +131,7 @@ In addition to all the usual series settings, you can switch series type. Click
131131

132132
## Custom tooltips
133133

134-
Ever needed to show just a bit more information on a chart without cluttering the entire visualization? With custom tooltips you can enrich your charts by selecting additional columns from your plotted DataFrame to display in the tooltip — not just those configured on the chart.
134+
Custom tooltips can show more information without adding it to the chart. Select other columns from the plotted DataFrame to display in the tooltip.
135135

136136
It’s perfect for highlighting more information for an unusual data point on a scatterplot or adding context with an extra metric on your bar charts, all without overwhelming your audience.
137137

‎docs/conda-environment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ noContent: false
66

77
[Anaconda Inc.](https://www.anaconda.com/) maintains a repository of thousands of curated packages for data science.
88

9-
Deepnote comes with a pre-built conda environment which allows users to instantly take advantage of the Anaconda ecosystem. This includes being able to use conda—a widely used CLI tool for package management which will include packages from the [Miniconda Installer](https://docs.conda.io/en/latest/miniconda.html).
9+
Deepnote comes with a pre-built conda environment. You can use the conda CLI to manage packages from [conda channels](https://docs.conda.io/projects/conda/en/latest/user-guide/concepts/channels.html).
1010

1111
## How to use the conda environment Deepnote
1212

‎docs/converting-notebooks.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Converting notebooks to and from Deepnote format
3-
description: Learn how to convert between Deepnote project files (`.deepnote`) and other notebook formats — Jupyter (`.ipynb`), Quarto (`.qmd`), Percent (`.py`), and Marimo (`.py`) — using the `@deepnote/convert` tool.
3+
description: Learn how to use the `@deepnote/convert` tool to convert between Deepnote project files (`.deepnote`) and Jupyter (`.ipynb`), Quarto (`.qmd`), Percent (`.py`), or Marimo (`.py`) notebooks.
44
noIndex: false
55
noContent: false
66
---
@@ -32,7 +32,7 @@ After converting your notebooks, you can open them either in Deepnote or directl
3232
Option 1: Open directly in [Deepnote](https://deepnote.com)
3333

3434
1. Load the `.deepnote` file in the Deepnote application.
35-
2. Configure the environment — install required Python packages and set environment variables.
35+
2. Configure the environment by installing required Python packages and setting environment variables.
3636
3. Run the notebook in Deepnote Cloud to collaborate in real time, build data apps, and enhance your workflow with AI tools.
3737

3838
Option 2: Open in your IDE
@@ -52,7 +52,7 @@ Option 2: Open in your IDE
5252

5353
## CLI usage
5454

55-
The package provides a `deepnote-convert` command-line tool for converting notebooks. Pass any supported file as the `<path>` argument — the tool detects the input format automatically (`.ipynb`, `.qmd`, or a `.py` file in Percent or Marimo format) and produces a `.deepnote` file. Pass a `.deepnote` file to convert in the reverse direction (see [Converting .deepnote to other formats](#converting-deepnote-to-other-formats)).
55+
The package provides a `deepnote-convert` command-line tool for converting notebooks. Pass any supported file as the `<path>` argument. The tool detects the input format (`.ipynb`, `.qmd`, or a `.py` file in Percent or Marimo format) and produces a `.deepnote` file. Pass a `.deepnote` file to convert in the reverse direction (see [Converting .deepnote to other formats](#converting-deepnote-to-other-formats)).
5656

5757
### Convert a single notebook
5858

@@ -62,7 +62,7 @@ Convert a single `.ipynb` file to a `.deepnote` file:
6262
deepnote-convert path/to/notebook.ipynb
6363
```
6464

65-
This creates a `notebook.deepnote` file in the current directory containing a single-notebook project. Quarto (`.qmd`), Percent (`.py`), and Marimo (`.py`) files are converted the same way — just pass the file path.
65+
This creates a `notebook.deepnote` file in the current directory containing a single-notebook project. To convert Quarto (`.qmd`), Percent (`.py`), or Marimo (`.py`) files, pass the file path to the same command.
6666

6767
**Example:**
6868

@@ -219,15 +219,15 @@ This workflow allows you to work with Deepnote's enhanced features and collabora
219219

220220
### Migrating existing projects
221221

222-
Convert an entire project directory — each notebook becomes its own `.deepnote` file:
222+
Convert an entire project directory. Each notebook becomes its own `.deepnote` file:
223223

224224
```bash
225225
deepnote-convert ~/jupyter-projects/data-analysis -o ~/deepnote-projects/
226226
```
227227

228228
### Batch conversion script
229229

230-
Create a script to convert multiple projects. (For a plain directory of notebooks, `deepnote-convert <dir>` already writes one `.deepnote` per notebook — a script like this is only needed for custom logic.)
230+
Create a script to convert multiple projects. For a plain directory of notebooks, `deepnote-convert <dir>` writes one `.deepnote` file per notebook, so you only need a script for custom logic.
231231

232232
```typescript
233233
import { convertIpynbFileToDeepnoteFile } from "@deepnote/convert";

‎docs/custom-environment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ pip install tensorflow -c https://tk.deepnote.com/constraints<PYTHON_VERSION>.tx
3535

3636
```
3737

38-
This constraints file helps prevent library conflicts and ensures compatibility with Deepnote's features like the variable explorer and interactive DataFrame views. Don't worry about installing additional dependencies for these features—we'll automatically detect and load them at runtime.
38+
This constraints file helps prevent library conflicts and ensures compatibility with Deepnote's features like the variable explorer and interactive DataFrame views. You don't need to install dependencies for these features. Deepnote detects and loads them at runtime.
3939

4040
## How to create a custom environment?
4141

‎docs/data-apps.md‎

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)