Open
Conversation
The repository was a raw markdown collection with no deploy path, so this adds a VitePress shell, a portal-style home page, generated navigation, link normalization helpers, and a GitHub Pages workflow that can publish directly from main. Constraint: Preserve the existing markdown tree instead of migrating content into a new docs subtree Constraint: GitHub Pages base path must match the current repository name Embed_book Rejected: Docusaurus setup | heavier configuration and content migration overhead for a mostly static knowledge base Rejected: Manual sidebar config | too brittle for mixed Chinese paths and README/Readme entry points Confidence: high Scope-risk: moderate Reversibility: clean Directive: If the repo name changes, update the VitePress base path before the next deployment Tested: npm run docs:check-links; npm run docs:build; verified generated HTML entry files in .vitepress/dist Not-tested: Live GitHub Pages publish status after remote push
Agent-Logs-Url: https://github.com/liueggy/Embed_book/sessions/e9be28f1-bdec-44c0-a472-74088eddd279 Co-authored-by: liueggy <161451396+liueggy@users.noreply.github.com>
…ing page The previous home screen leaned on a dark gradient hero and colorful portal cards, which made the site feel more like a generic blog theme than a documentation entry point. This revision reduces visual noise, flattens the palette, and restructures the content into ordered lists and index rows that foreground navigation over promotion. Constraint: Keep the existing VitePress home layout and reuse the current content structure without touching section pages Rejected: Minor color tweak only | would not remove the blog-like card/hero impression Rejected: Remove the custom home page entirely | would lose the curated learning-path entry points Confidence: high Scope-risk: narrow Reversibility: clean Directive: Keep future homepage changes aligned with a documentation-index feel; avoid reintroducing dark marketing hero treatments Tested: npm run docs:check-links; npm run docs:build Not-tested: Visual comparison on multiple mobile browsers after deployment
This revision starts turning the markdown collection into a cleaner reference set: chapter one is rewritten into a more complete tutorial-style structure, the surrounding notes have emoji removed for a more stable technical tone, and link normalization is updated so code fences no longer confuse markdown-link checks. Constraint: Preserve the existing repository layout and chapter entry files while improving readability in place Constraint: Keep the current GitHub Pages/VitePress site working during content cleanup Rejected: Rewrite all chapters in one pass | too much uncontrolled content churn for one review cycle Rejected: Only strip emoji without restructuring chapter one | would not establish the target writing standard for later chapters Confidence: high Scope-risk: moderate Reversibility: clean Directive: Continue future chapter rewrites in small passes using the same explanatory structure established in chapter one Tested: npm run docs:fix-links; npm run docs:check-links; npm run docs:build Not-tested: Human editorial review of every chapter after emoji removal
Agent-Logs-Url: https://github.com/liueggy/Embed_book/sessions/3b083a51-b0de-44de-9e59-dcce2f85d951 Co-authored-by: liueggy <161451396+liueggy@users.noreply.github.com>
|
这是来自QQ邮箱的假期自动回复邮件。
你好，我最近正在休假中，无法亲自回复你的邮件。我将在假期结束后，尽快给你回复。
|
There was a problem hiding this comment.
Pull request overview
该 PR 将仓库内容整理为可通过 VitePress 构建并部署到 GitHub Pages 的文档站点，同时对部分章节 README 与入口页进行结构化优化，提升导航与阅读体验。
Changes:
- 引入 VitePress 站点配置、主题样式与首页/学习地图/资源中心等入口页面。
- 新增
scripts/docs-tools.mjs：生成 nav/sidebar/rewrites，并提供本地 Markdown 链接检查/修复 CLI。 - 将多个章节的 README 重写为更“导读式”的结构，并补齐 books/面试等资源入口页内容。
Reviewed changes
Copilot reviewed 25 out of 27 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| study-map.md | 新增“学习地图”入口页，串联主线与专题/资源。 |
| scripts/docs-tools.mjs | 新增文档工具：链接规范化、断链检查、生成 nav/sidebar/rewrites。 |
| resources.md | 新增资源中心页，汇总 books 与 PDF 入口及阅读建议。 |
| package.json | 新增 VitePress dev/build/preview 与链接检查脚本。 |
| package-lock.json | 锁定 VitePress 及其依赖。 |
| index.md | 新增站点首页（home layout）与课程/专题入口。 |
| books/README.md | 重写 books 资源页为结构化索引与说明。 |
| 09-2025_AI_on_MCU/README.md | 重写专题章节为“目标/建议/概念链路”式导读。 |
| 07-Debug_Optimization/README.md | 重写调试与优化章节结构与内容层次。 |
| 06-NetworkIot/README.md | 重写 IoT 章节为“链路视角”的结构化内容。 |
| 05-EmbeddedLinux/README.md | 重写嵌入式 Linux 章节导读与知识结构。 |
| .vitepress/theme/index.ts | 引入自定义主题样式并扩展默认主题。 |
| .vitepress/theme/custom.css | 新增站点主页/入口样式（portal-table 等）。 |
| .vitepress/config.ts | 新增 VitePress 配置：base、cleanUrls、nav/sidebar、rewrites 等。 |
| .gitignore | 增加 Node/VitePress 构建产物忽略规则。 |
| .github/workflows/deploy.yml | 新增 GitHub Pages 部署工作流。 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Author
|
@copilot apply changes based on the comments in this thread |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.