Merge pull request #5 from hydrosquall/cameron.yick/2024-vega-lite-up…

…date

feat: update instructions and dependencies for Feb 2024 Release

README.md

@@ -6,19 +6,19 @@ A Python script to generate offline documentation for [vega-lite](https://github
 
 - In-page table of contents for all pages, including images and examples for each Vega-Lite spec property.
 - Mobile friendly layout (sidebars have been removed)
-- Quick search of all pages on the public docs page, including examples. (Note that examples that load remote data require an internet connection to load normally.)
+- Quick search of all pages on the public docs page, including examples. (Note examples that load remote data require an internet connection to load normally.)
 
 ## Custom Usage
 
-This step is only necessary if you intend to hack on the published docset locally. Otherwise, it can be installed from the Dash app or the [Dash contributions repository](https://github.com/Kapeli/Dash-User-Contributions).
+This step is only necessary if you intend to modify the published docset locally. Otherwise, it can be installed from the Dash app or the [Dash contributions repository](https://github.com/Kapeli/Dash-User-Contributions).
 
-1. Clone `vega-lite` as a sibling folder of this repository using the changes from [this PR](https://github.com/vega/vega-lite/pull/7642).
+1. Clone `vega-lite` as a sibling directory of this repository using changes from [this PR](https://github.com/vega/vega-lite/pull/7642).
 2. In that directory, run `yarn install && yarn docset` to generate the site
-  a. You may need to install `rbenv` and `Jekyll` to build the documentation site.
+  - You may need to install `rbenv`, `Jekyll`, and a recent version of Ruby to build the documentation site.
 3. In your python virtual environment, add python dependencies: `pip install -r requirements.txt`
-  a. Using Jupyter is optional, but recommended for ease of debugging the notebook output.
+  - Using Jupyter is optional, but recommended for ease of debugging notebook output.
 4. Run `jupyter notebook`, and double-click `generate-vega-lite-docset.ipynb`. Run all cells.
-5. Your generated docset will be in `vega-lite.docset`
+5. Your generated docset will be this directory `vega-lite.docset` . Use "File > Open Local Docset" to test the file before submitting it.
 
 See [notebook](./generate-vega-lite-docset.ipynb) for detailed instructions. The `DEBUG` flag can be toggled to adjust the amount of logging.