Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Checkpoint to make sure config file is set up correctly added to the getting started guide #4820

Merged
merged 2 commits into from
Jan 24, 2025

Conversation

miertla
Copy link
Contributor

@miertla miertla commented Jun 15, 2023

Description

Added a quick checkpoint to ensure the config file is set up correctly prior to users importing their music library. This was something I discovered later after running into an issue with my config file and hope it helps new users avoid the issues I had.

To Do

  • Documentation. (If you've add a new command-line flag, for example, find the appropriate page under docs/ to describe it.)
  • Changelog.(not required, @JOJ0 patched it out)
  • Tests. (Encouraged but not strictly required.)

Copy link
Member

@sampsyo sampsyo left a comment

Choose a reason for hiding this comment

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

It's not a bad idea to have something like this! I have a suggestion for keeping this short and to the point; let me know what you think.

docs/guides/main.rst Outdated Show resolved Hide resolved
docs/guides/main.rst Outdated Show resolved Hide resolved
@JOJ0
Copy link
Member

JOJ0 commented Jan 24, 2025

Applied suggestion and merging this tiny docs improvement.

@JOJ0 JOJ0 merged commit 80bc539 into beetbox:master Jan 24, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants