Update docs

Author: ryantam626

dev.md

@@ -93,6 +93,14 @@ For example to override settings for the `autopep8` formatter, enter something l
 
 :::{warning}
 This plugin does not pick up file based configuration at the moment (e.g. setup.cfg, pyproject.yml, etc.)
+
+Ticket is already opened at [#167](https://github.com/ryantam626/jupyterlab_code_formatter/issues/167).
+:::
+
+:::{warning}
+This plugin might be out of sync with the list of possibilities of configuration option.
+
+See [settings.json](https://github.com/ryantam626/jupyterlab_code_formatter/blob/master/schema/settings.json) for the JSON schema used, feel free to open a PR for updating it.
 :::
 
 ## Chaining Formatters Invocation

docs/configuration.md

@@ -1,49 +1,15 @@
 # Development
 
-1. Get Task - A Go task runner
+Prerequisites:
 
-```bash
-sudo sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
-```
+- Install [task](https://taskfile.dev);
+- Install docker, with buildkit;
 
-2. Build docker image for dev
+1. Spin up docker compose based dev env - `task dev:up`
+2. Run `jlpm watch` inside dev container - `task dev:jlpm-watch`
+3. In another terminal, run `jupyter lab` inside dev container - `task dev:jupyter-lab`
 
-```bash
-task dev:build
-```
+This watches the source directory and run JupyterLab at the same time in different terminals to watch for changes in the
+extension's source and automatically rebuild the extension inside the dev docker container.
 
-3. Obtain a shell
-
-```bash
-task dev:shell
-# NOTE: If you have a running container already, use the following instead
-task dev:shell-reuse
-```
-
-4. Live compilation of Lab Extension
-
-Assume you have a shell in dev container, do
-
-```bash
-jlpm run build
-jlpm run watch
-```
-
-5. Start JupyterLab
-
-Do this in another terminal.
-
-Assume you have a shell in dev container, do
-
-````{tab} Watch mode
-```bash
-# NOTE: This might take a little while...
-./dev/start-jupyterlab.sh --watch
-```
-````
-
-````{tab} Non-watch mode
-```bash
-./dev/start-jupyterlab.sh
-```
-````
+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).

docs/dev.md

@@ -15,12 +15,6 @@ your-support.md
 
 # JupyterLab Code Formatter
 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ryantam626/jupyterlab_code_formatter/master?urlpath=lab)
-[![npm version](https://badge.fury.io/js/%40ryantam626%2Fjupyterlab_code_formatter.svg)](https://badge.fury.io/js/%40ryantam626%2Fjupyterlab_code_formatter)
-[![npm downloads](https://img.shields.io/npm/dw/%40ryantam626%2Fjupyterlab_code_formatter.svg)](https://badge.fury.io/js/%40ryantam626%2Fjupyterlab_code_formatter)
-[![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-[![Github Actions Status](https://github.com/ryantam626/jupyterlab_code_formatter/workflows/CI/badge.svg)](https://github.com/ryantam626/jupyterlab_code_formatter/actions)
-
 *A JupyterLab plugin to facilitate invocation of code formatters.*
 
 **Source Code**: [GitHub](https://github.com/ryantam626/jupyterlab_code_formatter/).
@@ -31,7 +25,7 @@ your-support.md
 
 ## Requirements
 
-- Python 3.6+
+- Python 3.7+
 - JupyterLab >= 3.0.0
 - Any supported code formatters (you can also specify your own, see [custom formatter](custom-formatter.md)).
 
@@ -50,12 +44,6 @@ pip install jupyterlab-code-formatter
 ```
 ````
 
-````{tab} Conda
-```bash
-conda install -c conda-forge jupyterlab_code_formatter
-```
-````
-
 ````{tab} Poetry
 ```bash
 poetry add jupyterlab-code-formatter
@@ -69,15 +57,34 @@ pipenv install jupyterlab-code-formatter
 ````
 
 2. **Install some supported formatters** (isort+black are default for Python)
+````{tab} Pip
 ```bash
 # NOTE: Install black and isort,
 #       JL code formatter is configured to invoke isort and black by default
 pip install black isort
 ```
+````
+
+````{tab} Poetry
+```bash
+# NOTE: Install black and isort,
+#       JL code formatter is configured to invoke isort and black by default
+poetry add black isort
+```
+````
+
+````{tab} Pipenv
+```bash
+# NOTE: Install black and isort,
+#       JL code formatter is configured to invoke isort and black by default
+pipenv install black isort
+```
+````
 
 3. **Restart JupyterLab**
 
-This plugin includes a server plugin, restart JupyterLab if you have followed the above steps while it's running.
+This plugin includes a server plugin, as suck you will need to restart JupyterLab if you have followed
+the above steps while it's running.
 
 4. **Configure plugin**
 

docs/index.md

@@ -14,7 +14,7 @@ Here is a non-exhaustive list of possibilities:
 
 These commands invoke the specified code formatter in the current focused cell.
 
-To find out what formatters are available, you can query http://localhost:8888/jupyterlab_code_formatter/formatters?bypassVersionCheck=1 (you might need to replace the port and address), the keys of formatter are shown there.
+To find out what formatters are available, you can query http://localhost:8888/jupyterlab_code_formatter/formatters (you might need to replace the port and address), the keys of formatter are shown there.
 
 ---