Skip to content

Conversation

@codewithkenzo
Copy link
Owner

@codewithkenzo codewithkenzo commented Feb 2, 2026

Changed .scribblyrc.jsonscribbly.config.json in README.

Scout-detected fix.

Greptile Overview

Greptile Summary

Updates README to document the correct config filename (scribbly.config.json) instead of the old .scribblyrc.json.

Findings

  • [P1] README.md:154 The watch-mode example uses customscribbly.config.json (missing separator). Users copy/pasting will likely reference a non-existent file; should be something like custom.scribbly.config.json.

Confidence Score: 4/5

  • Safe to merge after fixing a small README example typo.
  • Change is documentation-only and mostly correct, but the introduced typo in the watch command (customscribbly.config.json) will mislead users and should be corrected before merge.
  • README.md

Important Files Changed

Filename Overview
README.md Renames documented config file from .scribblyrc.json to scribbly.config.json; introduces a typo in the watch example (customscribbly.config.json).

Sequence Diagram

sequenceDiagram
  autonumber
  participant Dev as Developer
  participant CLI as scribbly CLI
  participant FS as Project files

  Dev->>CLI: scribbly init
  CLI->>FS: Write scribbly.config.json
  Dev->>CLI: scribbly watch --config custom.scribbly.config.json
  CLI->>FS: Read custom.scribbly.config.json
  Note over Dev,CLI: README example should point to an existing config filename
Loading

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile


```bash
scribbly watch --config custom.scribblyrc.json
scribbly watch --config customscribbly.config.json
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The watch example config filename looks like it lost a separator during the rename. customscribbly.config.json is likely a typo and should probably be custom.scribbly.config.json (or another clearly separated name), otherwise users copying this command will pass a non-existent file.

Suggested change
scribbly watch --config customscribbly.config.json
scribbly watch --config custom.scribbly.config.json
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 154:154

Comment:
The watch example config filename looks like it lost a separator during the rename. `customscribbly.config.json` is likely a typo and should probably be `custom.scribbly.config.json` (or another clearly separated name), otherwise users copying this command will pass a non-existent file.

```suggestion
scribbly watch --config custom.scribbly.config.json
```

How can I resolve this? If you propose a fix, please make it concise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants