atom-community / atom-community/autocomplete-paths

Readme should contain real config.cson examples

Open
#196 5 comments 4 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
152
Forks
57
PR merge metrics
No merged PRs in 30d

Description

### Description

README.md recommends users add the following to config.cson

```cson
"autocomplete-paths":
scopes: [
{ ... },
{ ... },
]
```
But there's no indication what should be put in each scope. Should it be a complete copy of the settings? what is the name of the scope in that case, `scopes`?

One or two real world examples would help a lot

Contributor guide

Open the contributing guide

Research direction

Start with the README.md section containing the autocomplete-paths config.cson snippet and inspect the package's existing configuration expectations. Replace the placeholders with one or two real-world scope examples and clarify what belongs inside each scope. Done means a reader can understand and copy the examples without guessing how scopes are named or structured.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.