Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jupyter Notebook ecosystem docs improvements #6877

Merged
merged 20 commits into from
May 31, 2023
Merged
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# The Jupyter Notebook
# Jupyter Notebook Documentation

Welcome to the **Jupyter Notebook** documentation site. **Jupyter Notebook**
is a simplified notebook authoring application, and is a part of [Project
Jupyter](https://docs.jupyter.org/en/latest/), a large umbrella project
centered around the goal of providing tools (and [standards](https://docs.jupyter.org/en/latest/#sub-project-documentation))
for interactive computing with [computational notebooks](https://docs.jupyter.org/en/latest/#what-is-a-notebook).

A [computational notebook](https://docs.jupyter.org/en/latest/#what-is-a-notebook)
is a shareable document that combines computer
code, plain language descriptions, data, rich visualizations like 3D models,
charts, graphs and figures, and interactive controls. A notebook, along with
an editor like **Jupyter Notebook**, provides a fast interactive environment for
prototyping and explaining code, exploring and visualizing data, and sharing
ideas with others.

**Jupyter Notebook** is a sibling to other notebook authoring applications under
the Project Jupyter umbrella, like [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/)
and [Jupyter Desktop](https://github.com/jupyterlab/jupyterlab-desktop).
Jupyter Notebook offers a lightweight, simplified experience compared to JupyterLab.

Read more about how to use **Jupyter Notebook** on this site, in the [User
Documentation](notebook).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect, I think.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm testing an updated link now.


```{image} ./_static/images/notebook-running-code.png
32 changes: 19 additions & 13 deletions docs/source/notebook.md
Original file line number Diff line number Diff line change
@@ -4,19 +4,25 @@

## Introduction

The notebook extends the console-based approach to interactive computing in
a qualitatively new direction, providing a web-based application suitable for
capturing the whole computation process: developing, documenting, and
executing code, as well as communicating the results. The Jupyter notebook
combines two components:

**A web application**: a browser-based tool for interactive authoring of
documents which combine explanatory text, mathematics, computations and their
rich media output.

**Notebook documents**: a representation of all content visible in the web
application, including inputs and outputs of the computations, explanatory
text, mathematics, images, and rich media representations of objects.
**Jupyter Notebook** is a notebook authoring application, under the [Project
Jupyter](https://docs.jupyter.org/en/latest/) umbrella. Built on the power of
the [computational notebook format](https://docs.jupyter.org/en/latest/#what-is-a-notebook),
**Jupyter Notebook** offers fast, interactive new ways to prototype and explain
your code, explore and visualize your data, and share your ideas with others.

Notebooks extend the console-based approach to interactive computing in a
qualitatively new direction, providing a web-based application suitable for
capturing the whole computation process: developing, documenting, and executing
code, as well as communicating the results. The Jupyter notebook combines two
components:

**A web application:** A browser-based editing program for interactive authoring
of computational notebooks which provides a fast interactive environment for prototyping and
explaining code, exploring and visualizing data, and sharing ideas with others

**Computational Notebook documents**: A shareable document that combines computer
code, plain language descriptions, data, rich visualizations like 3D models, charts,
mathematics, graphs and figures, and interactive controls

```{seealso}
See the {ref}`installation guide <jupyter:install>` on how to install the
2 changes: 2 additions & 0 deletions docs/source/user-documentation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# User Documentation

Use this page to navigate to different parts of the user documentation.

```{toctree}
:maxdepth: 2