Skip to content

fix: correct config filename in README#7

Open
codewithkenzo wants to merge 1 commit intomainfrom
fix/readme-config-name
Open

fix: correct config filename in README#7
codewithkenzo wants to merge 1 commit intomainfrom
fix/readme-config-name

Conversation

@codewithkenzo
Copy link
Owner

@codewithkenzo codewithkenzo commented Feb 2, 2026

Changed .scribblyrc.jsonscribbly.config.json in 4 places.

Scout-detected fix.

Greptile Overview

Greptile Summary

This PR fixes a documentation discrepancy where the README referenced .scribblyrc.json instead of the actual config filename scribbly.config.json that the init command creates (see src/config.ts:52).

Changes:

  • Updated 4 instances in README.md to use correct filename scribbly.config.json
  • Aligns documentation with actual code behavior (initConfig writes to scribbly.config.json)
  • Note: .scribblyrc.json remains supported as a fallback in config loader for backward compatibility (src/config.ts:24)

No issues found. Clean documentation fix.

Confidence Score: 5/5

  • This PR is safe to merge with zero risk - it's a documentation-only fix
  • Perfect score because this is a straightforward documentation correction that aligns README with actual code behavior (src/config.ts:52 creates scribbly.config.json). No logic changes, no security implications, and all 4 instances were correctly updated.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Updated 4 references from .scribblyrc.json to scribbly.config.json to match actual config file created by init command

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI
    participant README
    participant ConfigLoader
    
    Note over README: Before PR: Referenced .scribblyrc.json
    Note over README: After PR: References scribbly.config.json
    
    User->>CLI: scribbly init
    CLI->>ConfigLoader: initConfig()
    ConfigLoader->>ConfigLoader: Write to ./scribbly.config.json
    ConfigLoader-->>User: Created default config at ./scribbly.config.json
    
    Note over README,ConfigLoader: Documentation now matches implementation
    
    User->>README: Read configuration docs
    README-->>User: Instructions reference scribbly.config.json ✓
    
    User->>CLI: scribbly generate
    CLI->>ConfigLoader: loadConfig()
    ConfigLoader->>ConfigLoader: Check ./scribbly.config.json (priority 1)
    ConfigLoader->>ConfigLoader: Check ./.scribblyrc.json (fallback)
    ConfigLoader-->>CLI: Return config
    
    Note over ConfigLoader: Backward compatibility maintained
Loading

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.

1 participant