Doesn't start as expected in the documentation
- Dominant language
- Python
- Stars
- 28
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Followed the documentation; created a new virtual environment and then install galley; and then the following:
$ galley
usage: galley [-h] [--no-destroy] [config] [pattern]
galley: error: argument config: can't open '/Users/burhan/work/projects/django/docs/.galley.yml': [Errno 2] No such file or directory: '/Users/burhan/work/projects/django/docs/.galley.yml'
So what's this `.galley.yml`?
Contributor guide
Research direction
Review the documentation that instructs users to run `galley` and reproduce the setup in a virtual environment. Clarify what `.galley.yml` is, when it is needed, and how users should create or provide it; verify the documented command no longer produces an unexplained missing-file error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100