AnswerDotAI / AnswerDotAI/shell_sage

Add API Documentation

Open
#36 3 comments 1 reaction 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
Jupyter Notebook
Stars
409
Forks
45
Avg merge
1m
Merged PRs (30d)
1

Description

Create comprehensive API documentation covering:
- Core functions and classes
- Parameters and return types
- Usage examples
- Error handling

Example additions:
```markdown
## 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.