docs: initial Jupyter support for website docs, move config notebook #1448
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jackgerrits
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1448 +/- ##
=======================================
Coverage 33.19% 33.19%
=======================================
Files 41 41
Lines 4950 4950
Branches 1135 1135
=======================================
Hits 1643 1643
Misses 3177 3177
Partials 130 130
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ekzhu
requested changes
Jan 30, 2024
|
Agreed - @zwd-ms has taken on that task and will be done separately to this PR to ensure it is a holistic solution |
ekzhu
approved these changes
Jan 30, 2024
|
Shall we move it under "Installation"? I think order wise, it's after installation and before use cases. |
I agree, moved it. |
whiskyboy
pushed a commit
to whiskyboy/autogen
that referenced
this pull request
Apr 17, 2024
…icrosoft#1448) * docs: jupyter support for website docs, move config docs * update devcontainer dockerfile, fix CI issues * update bsed on working directory * update TLDR * install into temp * remove unrelated change from diff * fix spelling issue * Update sidebars.js
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds initial support for rendering notebooks using
Quarto. Quarto is a tool for rendering technical documentation. It has specific support for rendering Jupyter notebooks that target the Docsaurus documentation system so it is particularly helpful for us.Additionally, in this PR I moved the oai_openai_utils notebooks to the main docs section as it is a great notebook for explaining how to setup the LLM config list. I made a small edit to add a
TL;DRsection at the top of the notebook to get started quickly.Sidebar with new page:
Example of rendered notebook:
Related issue number
#1339