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

Convert Notebook examples to documentation #123

Open
3 of 9 tasks
rgbkrk opened this issue Jan 16, 2024 · 0 comments
Open
3 of 9 tasks

Convert Notebook examples to documentation #123

rgbkrk opened this issue Jan 16, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@rgbkrk
Copy link
Owner

rgbkrk commented Jan 16, 2024

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:

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 rgbkrk added the good first issue Good for newcomers label Jan 16, 2024
rgbkrk added a commit that referenced this issue Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant