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

Add API Documentation #36

Open
devin-ai-integration bot opened this issue Feb 15, 2025 · 0 comments
Open

Add API Documentation #36

devin-ai-integration bot opened this issue Feb 15, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@devin-ai-integration
Copy link
Contributor

Create comprehensive API documentation covering:

  • Core functions and classes
  • Parameters and return types
  • Usage examples
  • Error handling

Example additions:

## API Reference
### get_sage(provider, model, base_url=None, api_key=None, mode='default')
Creates a new ShellSage instance with specified configuration.

Parameters:
- provider: str - The AI provider to use ('anthropic' or 'openai')
- model: str - Model name to use

Estimated time: 3-4 hours

@devin-ai-integration devin-ai-integration bot added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 15, 2025
@ncoop57 ncoop57 added the help wanted Extra attention is needed label Feb 15, 2025
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant