AnswerDotAI/shell_sage

Add API Documentation

Open

#36 opened on Feb 15, 2025

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)Jupyter Notebook (44 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (406 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Review the existing codebase to understand the public API, then add docstrings to functions and create a comprehensive documentation page.
Tech stack
python
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70