Skip to content

Conversation

@codewithkenzo
Copy link
Owner

@codewithkenzo codewithkenzo commented Feb 2, 2026

Updates README to reference correct config filename: scribbly.config.json instead of .scribblyrc.json

Greptile Overview

Greptile Summary

Updated README.md to reference the correct config filename scribbly.config.json instead of .scribblyrc.json in 2 locations (lines 47 and 210).

Issues found:

  • README.md:102 - Configuration section header still references .scribblyrc.json
  • README.md:154 - Example command still uses custom.scribblyrc.json

The code (src/config.ts:52) confirms that scribbly init creates scribbly.config.json as the primary config file, though .scribblyrc.json is supported as a fallback for backwards compatibility.

Confidence Score: 3/5

  • Safe to merge after fixing the 2 remaining inconsistent config filename references
  • PR correctly updates 2 references but misses 2 others on lines 102 and 154 - incomplete documentation fix needs completion to avoid user confusion
  • README.md needs 2 more config filename updates on lines 102 and 154

Important Files Changed

Filename Overview
README.md Updated 2 config filename references but missed 2 others (lines 102, 154)

Sequence Diagram

sequenceDiagram
    participant User
    participant README
    participant CLI as scribbly init
    participant Config as config.ts
    
    User->>README: Reads documentation
    README-->>User: Instructions reference scribbly.config.json (lines 47, 210)
    README-->>User: But also references .scribblyrc.json (lines 102, 154)
    
    User->>CLI: Runs scribbly init
    CLI->>Config: initConfig()
    Config->>Config: Create ./scribbly.config.json
    Config-->>User: Config file created
    
    Note over User,README: Inconsistency: README shows both filenames
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, 2 comments

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Feb 2, 2026

Additional Comments (2)

README.md
inconsistent config filename - should be scribbly.config.json to match the rest of the documentation

Create a `scribbly.config.json` file in your project root:

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 102:102

Comment:
inconsistent config filename - should be `scribbly.config.json` to match the rest of the documentation

```suggestion
Create a `scribbly.config.json` file in your project root:
```

<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>

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

README.md
inconsistent config filename - should be scribbly.config.json to match the actual config file created by scribbly init

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:
inconsistent config filename - should be `scribbly.config.json` to match the actual config file created by `scribbly init`

```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