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: Update setup docs #884

Merged
merged 1 commit into from
Dec 17, 2024
Merged

docs: Update setup docs #884

merged 1 commit into from
Dec 17, 2024

Conversation

tianjing-li
Copy link
Collaborator

@tianjing-li tianjing-li commented Dec 17, 2024

Thank you for contributing to the Cohere Toolkit!

  • PR title: "area: description"

    • Where "area" is whichever of interface, frontend, model, tools, backend, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes.
    • Example: "deployment: add Azure model option"
  • PR message: Delete this entire checklist and replace with

    • Description: a description of the change
    • Issue: the issue # it fixes, if applicable
    • Dependencies: any dependencies required for this change
  • Add tests and docs: Please include testing and documentation for your changes

  • Lint and test: Run make lint and make run-tests

AI Description

This PR introduces several changes to the Cohere Toolkit documentation, focusing on setup instructions, tool authentication, and configuration.

Setup Instructions:

  • README.md: The local setup instructions now include the installation of Poetry alongside Docker and Docker Compose.
  • docs/setup.md: The setup guide has been restructured, with a new section for installing Poetry, Docker, and Docker Compose. The manual configuration section has been updated to mention the secrets.yaml file and provide specific environment variable names.

Tool Authentication:

  • docs/custom_tool_guides/tool_auth_guide.md: The tool authentication guide now suggests creating an authentication class, providing examples from GMail, GDrive, and Slack. It also clarifies that the auth_implementation should be added to the tool's get_tool_definition method.

Configuration:

  • docs/setup.md: The environment variable configuration section has been updated to mention secrets.yaml and provide specific variable names for cohere_platform.api_key, database.url, and redis.url.
  • src/backend/config/configuration.template.yaml: The configuration template now includes 'brave_web_search' in the list of web search tool names.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.91%. Comparing base (fc64a71) to head (a7a583b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #884   +/-   ##
=======================================
  Coverage   77.91%   77.91%           
=======================================
  Files         259      259           
  Lines       11150    11150           
=======================================
  Hits         8688     8688           
  Misses       2462     2462           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tianjing-li tianjing-li merged commit 49f70b9 into main Dec 17, 2024
7 of 8 checks passed
@tianjing-li tianjing-li deleted the update-setup-docs branch December 17, 2024 19:12
Copy link
Collaborator

@EugeneLightsOn EugeneLightsOn left a comment

Choose a reason for hiding this comment

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

Thank you, I leave some notes

README.md Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

line 55 - Do we need to include all available tools to this list?
line 68 - Coming soon: Support for tools that require authentication. - Already implemented for GMail, GDrive and Slack tools.

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.

4 participants