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

docs: Added self-instruct cookbook #1401

Closed
wants to merge 3 commits into from

Conversation

AveryYay
Copy link
Collaborator

@AveryYay AveryYay commented Jan 6, 2025

Description

self-instruct cookbook

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Wendong-Fan Wendong-Fan changed the title Added self-instruct cookbook docs: Added self-instruct cookbook Jan 6, 2025
@Wendong-Fan Wendong-Fan added the documentation Improvements or additions to documentation label Jan 6, 2025
@Wendong-Fan Wendong-Fan added this to the Sprint 20 milestone Jan 6, 2025
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure how we are syncing this list with the camel doc site(https://docs.camel-ai.org/index.html). I simply count the number of the cookbooks and found the site has more cookbooks than the list here. Please sync the information.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the seed file, I believe that we need to follow the format shown in the example seed file to make everything work properly. Could you add a section which shows couple rows in the seed file and explain what is the meaning of each filed defined in the format. Thanks!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the suggestion! I have added a cell which prints some rows in the seed file and synced the cookbook table in README

@Wendong-Fan
Copy link
Member

close as finished, due to the cookbook structured was changed the cookbook is added in #1451,

@AveryYay AveryYay deleted the docs/self-instruct-cookbook branch January 24, 2025 17:43
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
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants