fix: correct inaccuracies across docs and config - #1
Conversation
- README.md: fix project structure reference (docs/ → guide/) - config.mts: fix broken logo path (.webp → .svg) and favicon type - hflive13.0-techdoc.md: fix backslash in image path - lyrics-display.md: fix dark-invert class applied to <p> instead of <img> - custom.css: remove @media wrapper so dark-invert works with manual toggle Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
Pull request overview
Documentation and configuration cleanup that fixes six small but real correctness issues across the VitePress site: a stale directory name in the README, a broken logo path, an invalid favicon MIME type, a Windows-style backslash in a Markdown image path, an inert {.dark-invert} attribute on a lyrics-display image, and an over-restrictive prefers-color-scheme wrapper around the dark-mode image-invert rule.
Changes:
- Fix README project structure (
docs/→guide/) and correct twoconfig.mtsissues (logo extension and favicon MIME type). - Fix one Markdown image path separator and one misplaced
{.dark-invert}attribute so the class targets the<img>. - Remove the
@media (prefers-color-scheme: dark)wrapper incustom.cssso manual dark-mode toggling still inverts SVGs.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates documented project structure from docs/ to actual guide/ directory. |
| .vitepress/config.mts | Corrects favicon type to image/svg+xml and logo path to existing .svg asset. |
| .vitepress/theme/custom.css | Drops prefers-color-scheme wrapper so manual dark-mode toggle still inverts images. |
| guide/hflive13.0-techdoc.md | Replaces backslash with forward slash in image/...svg path. |
| guide/lyrics-display.md | Removes stray space so {.dark-invert} applies to the image, not the wrapping <p>. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Validated all documentation and config files in the repo and fixed 6 inaccuracies:
docs/but the actual directory isguide/.logoreferenced/hflive-techdoc-logo.webpbut only.svgexists inpublic/— the site logo was broken.typewas"image"instead of the correct MIME type"image/svg+xml".image\校友连线接线图-提高.svg) instead of a forward slash.{.dark-invert}caused the class to be applied to the wrapping<p>element instead of the<img>— inconsistent with all other image references..dark-invertrule was wrapped in@media (prefers-color-scheme: dark), which meant dark mode image inversion would fail when a user manually toggles dark mode while their OS is set to light mode. Removed the unnecessary media query wrapper.Build passes cleanly after all changes.
Review & Testing Checklist for Human
.webpreference).dark-invertclass are properly inverted — this was broken beforeguide/lyrics-displayinverts in dark mode (the{.dark-invert}was on<p>instead of<img>)guide/hflive13.0-techdoc(had backslash path)Notes
Two images exist in
guide/image/but are not referenced by any documentation page:2021春晚实际接线图.svgand人员组织架构.svg. These may be planned for future use, so they were not removed.Link to Devin session: https://app.devin.ai/sessions/1ff79d2da5464cdbb7a62069ca8210c0
Requested by: @xiaoxuan010