Skip to content

docs: replace generic readiness template #17

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.

Sign up for GitHub

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

Merged
CoreyLeath-code merged 1 commit into from
Aug 6, 2026
Merged

docs: replace generic readiness template #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,9 @@
LogSight-AI is a local-first Python CLI for parsing common log formats, summarizing error patterns, detecting message-length outliers, and locating error-rate spikes. The production package does not transmit logs or require credentials.


## Production Readiness Guide
LogSight-AI parses local log files and standard input into typed events, summaries, outlier findings, and error-rate spike reports. It does not operate a hosted service, persist logs, or claim learned incident-detection accuracy. A production deployment would require a supported service boundary, authenticated multi-user access, retention and redaction controls, observability, and an owned deployment and rollback path.

> This section is the portfolio audit entry point for **LogSight-AI**. It describes an engineering promotion path; it is not a claim that the repository is already production-authorized.

[![CI](https://img.shields.io/github/actions/workflow/status/CoreyLeath-code/LogSight-AI/ci.yml?branch=main&label=CI)](https://github.com/CoreyLeath-code/LogSight-AI/actions) [![License](https://img.shields.io/github/license/CoreyLeath-code/LogSight-AI)](https://github.com/CoreyLeath-code/LogSight-AI/blob/main/LICENSE)

### Architecture flowchart
## Architecture flowchart

```mermaid
flowchart LR
Expand Down