Skip to content

Commit 11cb93f

Browse files
Jupyter Notebook ecosystem docs improvements (#6877)
* Add Project Jupyter info, extra context and detail to home page/index. * Added links, minor formatting. * Updated homepage, adapted unified messaging on notebook page. * Updated links. * Added minimal description to the user-documentation main page. * Revised notebook introduction text. * Bullet point updates. * Fixed typo. * Link update. * Changed lightweight to simplified. * Added Jupyter Desktop link. * Added standards info/links. * Update standards link. * Update standards link. * Update link. * Added extension to markdown file link.
1 parent a30b241 commit 11cb93f

File tree

3 files changed

+44
-14
lines changed

3 files changed

+44
-14
lines changed

docs/source/index.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
1-
# The Jupyter Notebook
1+
# Jupyter Notebook Documentation
2+
3+
Welcome to the **Jupyter Notebook** documentation site. **Jupyter Notebook**
4+
is a simplified notebook authoring application, and is a part of [Project
5+
Jupyter](https://docs.jupyter.org/en/latest/), a large umbrella project
6+
centered around the goal of providing tools (and [standards](https://docs.jupyter.org/en/latest/#sub-project-documentation))
7+
for interactive computing with [computational notebooks](https://docs.jupyter.org/en/latest/#what-is-a-notebook).
8+
9+
A [computational notebook](https://docs.jupyter.org/en/latest/#what-is-a-notebook)
10+
is a shareable document that combines computer
11+
code, plain language descriptions, data, rich visualizations like 3D models,
12+
charts, graphs and figures, and interactive controls. A notebook, along with
13+
an editor like **Jupyter Notebook**, provides a fast interactive environment for
14+
prototyping and explaining code, exploring and visualizing data, and sharing
15+
ideas with others.
16+
17+
**Jupyter Notebook** is a sibling to other notebook authoring applications under
18+
the Project Jupyter umbrella, like [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/)
19+
and [Jupyter Desktop](https://github.com/jupyterlab/jupyterlab-desktop).
20+
Jupyter Notebook offers a lightweight, simplified experience compared to JupyterLab.
21+
22+
Read more about how to use **Jupyter Notebook** on this site, in the [User
23+
Documentation](notebook.md).
224

325
```{image} ./_static/images/notebook-running-code.png
426

docs/source/notebook.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,25 @@
44

55
## Introduction
66

7-
The notebook extends the console-based approach to interactive computing in
8-
a qualitatively new direction, providing a web-based application suitable for
9-
capturing the whole computation process: developing, documenting, and
10-
executing code, as well as communicating the results. The Jupyter notebook
11-
combines two components:
12-
13-
**A web application**: a browser-based tool for interactive authoring of
14-
documents which combine explanatory text, mathematics, computations and their
15-
rich media output.
16-
17-
**Notebook documents**: a representation of all content visible in the web
18-
application, including inputs and outputs of the computations, explanatory
19-
text, mathematics, images, and rich media representations of objects.
7+
**Jupyter Notebook** is a notebook authoring application, under the [Project
8+
Jupyter](https://docs.jupyter.org/en/latest/) umbrella. Built on the power of
9+
the [computational notebook format](https://docs.jupyter.org/en/latest/#what-is-a-notebook),
10+
**Jupyter Notebook** offers fast, interactive new ways to prototype and explain
11+
your code, explore and visualize your data, and share your ideas with others.
12+
13+
Notebooks extend the console-based approach to interactive computing in a
14+
qualitatively new direction, providing a web-based application suitable for
15+
capturing the whole computation process: developing, documenting, and executing
16+
code, as well as communicating the results. The Jupyter notebook combines two
17+
components:
18+
19+
**A web application:** A browser-based editing program for interactive authoring
20+
of computational notebooks which provides a fast interactive environment for prototyping and
21+
explaining code, exploring and visualizing data, and sharing ideas with others
22+
23+
**Computational Notebook documents**: A shareable document that combines computer
24+
code, plain language descriptions, data, rich visualizations like 3D models, charts,
25+
mathematics, graphs and figures, and interactive controls
2026

2127
```{seealso}
2228
See the {ref}`installation guide <jupyter:install>` on how to install the

docs/source/user-documentation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# User Documentation
22

3+
Use this page to navigate to different parts of the user documentation.
4+
35
```{toctree}
46
:maxdepth: 2
57

0 commit comments

Comments
 (0)