Skip to content

Commit 458ebb5

Browse files
committed
docs: split multi-sentence README paragraphs (sentences-per-line)
1 parent 11e75dc commit 458ebb5

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111

1212
## Overview
1313

14-
`grepo` automates the heavy lifting of repository maintenance. By integrating with LLM providers like Google Gemini, it intelligently analyzes your codebase to generate professional READMEs, suggest relevant repository topics, craft repository descriptions, summarize technologies, and recommend improvements.
14+
`grepo` automates the heavy lifting of repository maintenance.
15+
By integrating with LLM providers like Google Gemini, it intelligently analyzes your codebase to generate professional READMEs, suggest relevant repository topics, craft repository descriptions, summarize technologies, and recommend improvements.
1516

1617
### High-Level Flow
1718

@@ -30,7 +31,8 @@ flowchart LR
3031

3132
## Architecture
3233

33-
`grepo` is built on top of the [Effect](https://effect.website/) ecosystem, providing typed errors, composable services, and structured concurrency. The CLI is decomposed into **commands**, **services**, and **utilities**.
34+
`grepo` is built on top of the [Effect](https://effect.website/) ecosystem, providing typed errors, composable services, and structured concurrency.
35+
The CLI is decomposed into **commands**, **services**, and **utilities**.
3436

3537
### Module Layout
3638

@@ -108,7 +110,8 @@ flowchart TB
108110

109111
## Command Pipeline
110112

111-
Every command follows the same shape: **parse → fetch context → prompt → act**. The `readme` command adds analysis, generation, and mermaid validation phases.
113+
Every command follows the same shape: **parse → fetch context → prompt → act**.
114+
The `readme` command adds analysis, generation, and mermaid validation phases.
112115

113116
### Generic Command Flow
114117

@@ -267,7 +270,8 @@ flowchart TD
267270

268271
## Error Model
269272

270-
Errors are tagged data classes from `errors.ts`. Each command declares its possible failures in the type so `Effect.catchTags` can route them to user-friendly messages.
273+
Errors are tagged data classes from `errors.ts`.
274+
Each command declares its possible failures in the type so `Effect.catchTags` can route them to user-friendly messages.
271275

272276
```mermaid
273277
stateDiagram-v2
@@ -343,7 +347,8 @@ grepo describe https://github.com/owner/repo --apply
343347

344348
## Configuration
345349

346-
`grepo` requires authentication for repository access and AI analysis. Configure these via environment variables, a `.env` file, or `~/.grepo/config.json`:
350+
`grepo` requires authentication for repository access and AI analysis.
351+
Configure these via environment variables, a `.env` file, or `~/.grepo/config.json`:
347352

348353
| Key | Required for |
349354
| :---------------------------------- | :--------------------------------- |

0 commit comments

Comments
 (0)