From 7591fca2e5815f35ddbd0dfc59433e2c0a44680e Mon Sep 17 00:00:00 2001 From: amnweb <16545063+forumwt@users.noreply.github.com> Date: Thu, 2 Jan 2025 00:38:28 +0100 Subject: [PATCH] docs(FAQ): add installation and configuration troubleshooting tips --- docs/FAQ.md | 100 ++++++++++++++++++++++++++++++++++++++++++- docs/Installation.md | 2 +- 2 files changed, 100 insertions(+), 2 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 9bc155c..2d53f5d 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1 +1,99 @@ -(wip) \ No newline at end of file +# Frequently Asked Questions + +## Installation Issues + +### Q: Why aren't the icons showing up correctly? +**A:** This usually happens because: +- Required Nerd Fonts are not installed or other font defined in styles.css +- Recommended [JetBrainsMono Nerd Font](https://github.com/ryanoasis/nerd-fonts/releases/latest/download/JetBrainsMono.zip) +- Restart YASB after font installation + +### Q: Why doesn't the blur effect work? +**A:** Check these points: +- Windows 10/11 transparency effects are enabled in system settings +- The `blur_effect` is enabled in config.yaml +- Your GPU drivers are updated +- Windows composition is enabled + +## Configuration Issues + +### Q: Where are the configuration files located? +**A:** Default location: `C:/Users/{username}/.config/yasb/` +Required files: +- `config.yaml` - Main configuration +- `styles.css` - Visual styling + +### Q: YASB crashes after updating? +**A:** After updates: +- Check release notes for breaking changes +- Compare your config with the latest example config +- Backup your configs before updating + +### Q: How to reset YASB settings? +**A:** Delete the `config.yaml` and `styles.css` files in the config directory. YASB will create new default files on the next run. + +### Q: How to change the bar position? +**A:** Modify the `position` value in `config.yaml`: +- `top` - Top of the screen +- `bottom` - Bottom of the screen + +### Q: How to check for updates? +**A:** Run `yasbc update` in the terminal to check for updates. + +### Q: How to change the bar size? +**A:** Adjust the bar `height` value in `config.yaml` to change the bar size. + +### Q: How to check logs for errors? +**A:** Check the `yasb.log` file in the config directory for errors. or run `yasbc logs` in the terminal. + + +## Widget Issues + +### Q: Weather widget not working? +**A:** Verify: +- Valid API key from [weatherapi.com](https://www.weatherapi.com) +- Correct `api_key` and `location` in settings +- Active internet connection + +### Q: Missing applications in Taskbar widget? +**A:** Note: +- Only shows minimized windows +- System tray apps won't appear +- Check `window_class` filters in config + +## Performance Issues + +### Q: High CPU usage? +**A:** Common causes: +- Low `update_interval` values +- Too many real-time widgets +- Both `watch_config` and `watch_stylesheet` enabled + +### Q: Delayed startup? +**A:** Solutions: +- Use `yasbc enable-autostart --task` to create a scheduled task for YASB +- Check startup programs for conflicts + +## Styling Issues + +### Q: How to customize appearance? +**A:** Edit `styles.css`: +```css +.yasb-bar { /* Main bar */ } +.widget { /* All widgets */ } +.clock-widget { /* Specific widget */ } +``` + +### Q: CSS not working? +**A:** Limitations: +- Basic CSS properties supported +- No advanced CSS3 features +- Check syntax in styles.css +- Restart YASB after changes + + +## Getting Help + +- Check the [Wiki](https://github.com/amnweb/yasb/wiki) +- Join [Discord](https://discord.gg/Db6t9bUnQn) +- Open an [issue](https://github.com/amnweb/yasb/issues) \ No newline at end of file diff --git a/docs/Installation.md b/docs/Installation.md index 169da62..4e2f4ca 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,5 +1,5 @@ ### Requirements -- Nerd Fonts. Install [Nerd Fonts](https://www.nerdfonts.com/font-downloads) (JetBrainsMono recommended) +- Nerd Fonts. Install [Nerd Fonts](https://www.nerdfonts.com/font-downloads) ([JetBrainsMono](https://github.com/ryanoasis/nerd-fonts/releases/latest/download/JetBrainsMono.zip) recommended) - Windows 10 & 11 ### Installer