AnswerDotAI/shell_sage

Document Logging System

Open

#35 opened on Feb 15, 2025

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

Repository metrics

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

Description

Add documentation for the logging system including:

  • Database schema
  • Query examples
  • Log maintenance
  • Configuration options

Example additions:

## Logging
Logs are stored in SQLite at ~/.shell_sage/log_db/logs.db

Schema:
- timestamp: DateTime
- query: Text
- response: Text
- model: Text

Estimated time: 1-2 hours

Contributor guide

Research direction
Review the logging database schema and configuration files in the codebase, then write documentation based on the examples and requirements listed.
Tech stack
None
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85