Skip to content

Commit 7391ca1

Browse files
committed
Add troubleshooting section to README.md for common build and navigation issues
1 parent 614f547 commit 7391ca1

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,27 @@ The project uses **Dependabot** to automatically keep dependencies up to date. D
196196

197197
When updates are available, Dependabot creates pull requests automatically. Review and merge these PRs after verifying the CI workflow passes.
198198

199+
## Troubleshooting
200+
201+
### Build Fails
202+
- Check YAML syntax in post frontmatter
203+
- Verify all referenced images exist
204+
- Check `mkdocs.yml` for syntax errors
205+
- Review GitHub Actions logs for deployment failures
206+
207+
### Images Not Loading
208+
- Image paths must be relative to the markdown file (e.g., `![alt](image.webp)`)
209+
- Verify the image file exists in the same directory as the post's `index.md`
210+
211+
### Navigation Issues
212+
- File paths in the `nav:` section of `mkdocs.yml` must match actual file locations
213+
- New pages need to be added to `nav:` manually
214+
215+
### Styling Not Applied
216+
- Check `docs/stylesheets/extra.css` for syntax errors
217+
- Clear your browser cache
218+
- Theme updates may rename CSS classes — check the [Material for MkDocs changelog](https://squidfunk.github.io/mkdocs-material/changelog/)
219+
199220
## Resources
200221

201222
- [MkDocs Documentation](https://www.mkdocs.org)

0 commit comments

Comments
 (0)