Guides as notebooks #2945

htahir1 · 2024-08-23T13:30:31Z

Describe changes

I implemented a new GitHub Actions workflow to automatically update tutorials and replaced the Scarf checker workflow. This change achieves the following:

Removes the scarf-check.yml workflow, which is no longer needed.
Adds a new update-tutorials.yml workflow that:
- Converts Jupyter notebooks in the tutorials directory to Markdown files.
- Updates the corresponding Markdown files in the docs/book/user-guide directory.
- Generates a suggested table of contents for each guide.
- Creates a PR comment summarizing the changes.
Adds a new Python script update_tutorials.py to handle the conversion and updating process.
Adds new tutorial notebooks and corresponding Markdown files for a "Starter Guide".
Updates the toc.md file to include the new "Starter Guide" section.
Adds a README.md file in the tutorials directory explaining the purpose and structure of the tutorials.

These changes will streamline the process of keeping our documentation up-to-date with the latest tutorial content.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-08-23T13:30:36Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

review-notebook-app · 2024-08-23T13:30:36Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

socket-security · 2024-08-23T13:30:51Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
pypi/[email protected]	Transitive: environment, eval, filesystem, network, shell, unsafe	`+70`	845 MB	frenzymadness, hroncok
pypi/[email protected]	environment, eval, filesystem, network, shell Transitive: unsafe	`+8`	6.74 MB	Kyle.Kelley, MSeal, Sylvain.Corlay, ...11 more

View full report↗︎

This reverts commit de1dd8f.

github-actions · 2024-08-24T09:59:25Z

The GitBook content has been successfully updated.

github-actions · 2024-08-24T11:06:11Z

The tutorials content has been successfully updated.

github-actions · 2024-08-24T11:09:47Z

The tutorials content has been successfully updated.

github-actions · 2024-08-24T11:11:27Z

The tutorials content has been successfully updated.

github-actions · 2024-08-24T12:48:59Z