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

Fix/swekit docs #863

Merged
merged 2 commits into from
Nov 16, 2024
Merged

Fix/swekit docs #863

merged 2 commits into from
Nov 16, 2024

Conversation

abhishekpatil4
Copy link
Contributor

@abhishekpatil4 abhishekpatil4 commented Nov 16, 2024

changes made:

  1. Fixed minor typo in langgraph framework page
  2. Fixed swekit framework details
  3. Added a table containing the arguments, description & accepted values while creating for swekit

Important

Fix typos and update swekit documentation with argument details for swekit scaffold command.

  • Documentation Fixes:
    • Fix typo in langgraph.mdx ("obtained" instead of "obtaned").
    • Update framework details in swekit-examples/introduction.mdx and swekit/introduction.mdx to replace "CrewAI" with "LangChain".
  • Enhancements:
    • Add argument table in swekit-examples/introduction.mdx and swekit/introduction.mdx for swekit scaffold command, detailing -f and -o options.

This description was created by Ellipsis for 0d91e09. It will automatically update as commits are pushed.

Copy link

vercel bot commented Nov 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
composio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 16, 2024 7:36pm

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Reviewed everything up to 0d91e09 in 52 seconds

More details
  • Looked at 78 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 5 drafted comments based on config settings.
1. docs/framework/langgraph.mdx:76
  • Draft comment:
    Typo correction is valid. No issues here.
  • Reason this comment was not posted:
    Confidence changes required: 0%
    The PR author has corrected a typo in the langgraph.mdx file, which is a valid change.
2. docs/swekit-examples/introduction.mdx:23
  • Draft comment:
    Framework name updated from CrewAI to LangChain. Ensure this change is consistent across the documentation.
  • Reason this comment was not posted:
    Confidence changes required: 0%
    The PR author has updated the framework name from CrewAI to LangChain in the swekit-examples/introduction.mdx file. This change is consistent with the description and seems intentional.
3. docs/swekit-examples/introduction.mdx:83
  • Draft comment:
    'benchmark.py' file removed from the list. Ensure this change is consistent with the actual scaffolding process.
  • Reason this comment was not posted:
    Confidence changes required: 0%
    The PR author has removed the 'benchmark.py' file from the list of generated files in the swekit-examples/introduction.mdx file. This change is consistent with the description and seems intentional.
4. docs/swekit-examples/introduction.mdx:70
  • Draft comment:
    Table added for 'swekit scaffold' command arguments. This is a useful addition for clarity.
  • Reason this comment was not posted:
    Confidence changes required: 0%
    The PR author has added a table describing the arguments for the 'swekit scaffold' command in the swekit-examples/introduction.mdx file. This is a useful addition for clarity.
5. docs/swekit/introduction.mdx:84
  • Draft comment:
    Table added for 'swekit scaffold' command arguments. This is a useful addition for clarity.
  • Reason this comment was not posted:
    Confidence changes required: 0%
    The PR author has added a table describing the arguments for the 'swekit scaffold' command in the swekit/introduction.mdx file. This is a useful addition for clarity.

Workflow ID: wflow_6O4JNSpjeTTHLoXh


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

```
</CodeGroup>

| Argument | Description | Accepted Values |
Copy link
Contributor

Choose a reason for hiding this comment

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

This table duplicates existing documentation for the swekit scaffold command arguments already present in README.md and introduction.mdx. Consider consolidating the documentation to avoid redundancy.

Copy link

This comment was generated by github-actions[bot]!

JS SDK Coverage Report

📊 Coverage report for JS SDK can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/coverage-11872727622/coverage/index.html

📁 Test report folder can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/html-report-11872727622/html-report/report.html

@sohamganatra sohamganatra merged commit 9674d62 into master Nov 16, 2024
9 checks passed
@sohamganatra sohamganatra deleted the fix/swekit-docs branch November 16, 2024 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants