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.

Sign up for GitHub

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

Update readme #28

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Update readme #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28453a6
Add screencast
trungleduc Dec 20, 2024
d2e76ff
Update readme
trungleduc Dec 20, 2024
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
8 changes: 0 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,6 @@ jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

#### See also

Custom build doc: https://ocjs.org/docs/app-dev-workflow/custom-builds

Custom build example: https://github.com/donalffons/opencascade.js/blob/master/website/ocjs-editor-theme/src/customBuild/customBuild.yml

Where to find symbols: https://dev.opencascade.org/doc/refman/html/annotated.html

### Development uninstall

```bash
Expand Down
31 changes: 24 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,36 @@
# jupyterlab_suggestions
<h1 align="center">jupyterlab_suggestions</h1>

Copy link
Member

@jtpio jtpio Dec 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe we could also rename the heading to "jupyter-suggestions" to match the name of the repo and the packages?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

[![Github Actions Status](https://github.com/jupyterlab-contrib/jupyter-suggestions/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyter-suggestions/actions/workflows/build.yml)

A JupyterLab extension for suggesting changes.
<h2 align="center">A JupyterLab extension for suggesting changes</h2>

![screenshot of a cell suggestion in a notebook](./jupyter-suggestions.png)

## Status

⚠️ WIP ⚠️
![screencast of a cell suggestion in a notebook](./assets/suggestion-demo.mp4)

## Requirements

- JupyterLab >= 4.0.0

## Installation

To install the extension, use the following commands:

```bash
pip install jupyter-suggestions
```

By default, `jupyter-suggestions` uses notebook metadata to store suggestions. However, this approach has certain limitations:

- Changes made to the suggested cell are not reflected in the suggestion widget.
- Accepting a suggestion overwrites the content of the suggested cell.

To address these issues, you can install an additional package to utilize the forking capabilities of `jupyter-collaboration`.

```bash
pip install jupyter-suggestions-rtc
```

By using `jupyter-collaboration` as the backend for managing suggestions, the content of suggestions is merged directly into the suggested cell.

## Contributing

`jupyter-suggestions` is an open-source project, and contributions are always welcome. If you would like to contribute to `jupyter-suggestions`, please fork the repository and submit a pull request.
Expand Down
0 jupyter-suggestions.png → assets/jupyter-suggestions.png
View file
Open in desktop
File renamed without changes
Binary file added assets/suggestion-demo.mp4
View file
Open in desktop
Binary file not shown.
6 changes: 3 additions & 3 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10332,7 +10332,7 @@ __metadata:

"typescript@patch:typescript@>=3 < 6#~builtin<compat/typescript>, typescript@patch:typescript@^5#~builtin<compat/typescript>":
version: 5.7.2
resolution: "typescript@patch:typescript@npm%3A5.7.2#~builtin<compat/typescript>::version=5.7.2&hash=85af82"
resolution: "typescript@patch:typescript@npm%3A5.7.2#~builtin<compat/typescript>::version=5.7.2&hash=e012d7"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
Expand All @@ -10342,11 +10342,11 @@ __metadata:

"typescript@patch:typescript@~5.0.2#~builtin<compat/typescript>":
version: 5.0.4
resolution: "typescript@patch:typescript@npm%3A5.0.4#~builtin<compat/typescript>::version=5.0.4&hash=85af82"
resolution: "typescript@patch:typescript@npm%3A5.0.4#~builtin<compat/typescript>::version=5.0.4&hash=b5f058"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: bb309d320c59a26565fb3793dba550576ab861018ff3fd1b7fccabbe46ae4a35546bc45f342c0a0b6f265c801ccdf64ffd68f548f117ceb7f0eac4b805cd52a9
checksum: d26b6ba97b6d163c55dbdffd9bbb4c211667ebebc743accfeb2c8c0154aace7afd097b51165a72a5bad2cf65a4612259344ff60f8e642362aa1695c760d303ac
languageName: node
linkType: hard

Expand Down
Loading