Skip to content

fix: correct inaccuracies across docs and config - #1

Merged
xiaoxuan010 merged 2 commits into
mainfrom
devin/1780077680-fix-doc-inaccuracies
May 29, 2026
Merged

fix: correct inaccuracies across docs and config#1
xiaoxuan010 merged 2 commits into
mainfrom
devin/1780077680-fix-doc-inaccuracies

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Validated all documentation and config files in the repo and fixed 6 inaccuracies:

  1. README.md: Project structure listed docs/ but the actual directory is guide/.
  2. config.mts (logo): logo referenced /hflive-techdoc-logo.webp but only .svg exists in public/ — the site logo was broken.
  3. config.mts (favicon): Favicon type was "image" instead of the correct MIME type "image/svg+xml".
  4. hflive13.0-techdoc.md: Image path on line 248 used a backslash (image\校友连线接线图-提高.svg) instead of a forward slash.
  5. lyrics-display.md: A space before {.dark-invert} caused the class to be applied to the wrapping <p> element instead of the <img> — inconsistent with all other image references.
  6. custom.css: The .dark-invert rule 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

  • Verify the site logo renders correctly on the deployed site (was broken due to .webp reference)
  • Toggle dark mode manually (while your OS is in light mode) and check that SVG diagrams with .dark-invert class are properly inverted — this was broken before
  • Check that the 歌词显示方案选型 image in guide/lyrics-display inverts in dark mode (the {.dark-invert} was on <p> instead of <img>)
  • Verify the 校友连线接线图-提高 image renders in guide/hflive13.0-techdoc (had backslash path)

Notes

Two images exist in guide/image/ but are not referenced by any documentation page: 2021春晚实际接线图.svg and 人员组织架构.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

me and others added 2 commits May 29, 2026 18:02
- 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-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 two config.mts issues (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 in custom.css so 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.

@xiaoxuan010
xiaoxuan010 merged commit c5d022e into main May 29, 2026
1 check passed
@xiaoxuan010
xiaoxuan010 deleted the devin/1780077680-fix-doc-inaccuracies branch May 29, 2026 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants