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

Render the example notebooks in the documentation? #802

Closed
krassowski opened this issue May 22, 2024 · 0 comments · Fixed by #906
Closed

Render the example notebooks in the documentation? #802

krassowski opened this issue May 22, 2024 · 0 comments · Fixed by #906
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@krassowski
Copy link
Member

Problem

There is quite a few features which are not documented in the docs but have reasonably good examples in the example notebooks.

Proposed Solution

Should these examples be rendered in the user-facing docs so that users do not need to seach GitHub to understand what the %ai commands do?

Additional context

Many projects render notebooks with examples in the documentation, some only use notebooks.

@krassowski krassowski added documentation Improvements or additions to documentation enhancement New feature or request labels May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant