chatlab icon indicating copy to clipboard operation
chatlab copied to clipboard

Convert Notebook examples to documentation

Open rgbkrk opened this issue 1 year ago • 0 comments

A wealth of notebooks in here can be converted to full MDX within website/. Each one notebook is a worthy PR to get started with as a new page in src/docs/. These are the current notebooks in need of conversion to narrative linked documentation with interactives:

  • [ ] notebooks/the-data-science-helper.ipynb
  • [ ] notebooks/parallel-function-calling.ipynb
  • [ ] notebooks/knowledge-graph.ipynb
  • [ ] notebooks/color-picker.ipynb
  • [x] ~~notebooks/basics.ipynb~~
  • [x] ~~notebooks/function-registry.ipynb~~
    • Done in https://chatlab.dev/docs/api/function-registry
  • [ ] notebooks/open-model-functions.ipynb
  • [x] ~~notebooks/python-hallucination.ipynb~~
    • already in https://chatlab.dev/docs/interpreter#the-hidden-python-hallucination
  • [ ] notebooks/introduce-time.ipynb

Tasks:

For each notebook:

  1. Convert the Jupyter notebook to a Markdown file.
  2. Convert the Markdown file to an MDX file, adding JSX components where necessary.
  3. Add the MDX file to the website/docs/
  4. Create a PR for each notebook conversion.

Acceptance Criteria:

  • Each Jupyter notebook is successfully converted to an MDX file.
  • Each MDX file is added to the website/docs/ directory of the website.
  • A PR is created for each notebook conversion.

Alternate approach: automation

Originally I was setting up some automated tooling to bring in notebooks into docusaurus. Doing that effectively requires more work in docusaurus. If anyone's ready for that, then by all means!

rgbkrk avatar Jan 16 '24 20:01 rgbkrk