Skip to content

feat: add VitePress documentation site with GitHub Pages deployment - #21

Open
Doraemonblogs wants to merge 2 commits into
deusyu:mainfrom
Doraemonblogs:main
Open

feat: add VitePress documentation site with GitHub Pages deployment#21
Doraemonblogs wants to merge 2 commits into
deusyu:mainfrom
Doraemonblogs:main

Conversation

@Doraemonblogs

Copy link
Copy Markdown
Contributor
  • VitePress setup with sidebar navigation (9 sections, 37 translations grouped by source)
  • Custom landing page (hero + six core concept feature cards)
  • Local full-text search, dark mode, last-updated timestamps, edit-on-GitHub links
  • Custom indigo theme + Chinese typography optimizations
  • GitHub Actions workflow for auto-deploy to GitHub Pages
  • Fix: escape raw angle brackets in inside-the-scaffold-paper-translation.md (Vue compiler compat)
  • Config: base path, sitemap, social/edit links pointing to Doraemonblogs/harness-engineering

- VitePress setup with sidebar navigation (9 sections, 37 translations grouped by source)
- Custom landing page (hero + six core concept feature cards)
- Local full-text search, dark mode, last-updated timestamps, edit-on-GitHub links
- Custom indigo theme + Chinese typography optimizations
- GitHub Actions workflow for auto-deploy to GitHub Pages
- Fix: escape raw angle brackets in inside-the-scaffold-paper-translation.md (Vue compiler compat)
- Config: base path, sitemap, social/edit links pointing to Doraemonblogs/harness-engineering
- configure-pages@v5 with enablement: true (auto-enables GitHub Pages)
- checkout@v6, setup-node@v5, upload-pages-artifact@v4 (fix Node.js 20 deprecation)
- node-version 20 -> 24
@cursor

cursor Bot commented Aug 13, 2026

Copy link
Copy Markdown

Thanks for putting this together. I reviewed the PR against the latest main and tested it locally: npm ci && npm run build completes successfully, and all consistency checks pass. The implementation is thoughtful, especially the source-based grouping of translations, the Chinese typography, the GitHub Pages workflow, and the fix for the raw angle brackets in works/inside-the-scaffold-paper-translation.md.

After reviewing the direction for the docs site, I’ve decided not to merge #21 as-is and will instead continue with the implementation in #22. This isn’t a reflection on the quality of your work. The final site needs to deploy to harness.dyu.sh, and I want its navigation and displayed counts to be generated from the filesystem rather than maintained by hand. That required a broader architectural rewrite, including the new C14 consistency check.

To be clear, #22 builds on both the design and parts of the implementation in this PR—not just the general idea. It carries forward the choice of VitePress, the translation grouping, the typography details, much of the Pages workflow structure, and the hero-plus-concept-card layout. I’ve credited #21 in the PR description and source comments, and I’ll add you as a co-author to the main implementation commit before #22 is merged so the Git history reflects your contribution properly.

The two-line angle-bracket fix is already included in commit 579e7252 with your authorship preserved. If you’d prefer to submit that fix as a standalone PR first, let me know and I’ll rebase #22 on top of it.

Thanks again—this PR established the direction for the docs site and saved me a lot of work. I really appreciate the contribution and would be glad to collaborate again.

deusyu pushed a commit that referenced this pull request Aug 18, 2026
裸写的 <best_action_index> 与 <original>/<patched> 标签会被 Vue 编译器
当作组件解析(VitePress 构建直接报错),在 GitHub 的 Markdown 渲染中
也会被 HTML 清洗吞掉。以反引号内联代码转义后两边渲染都恢复正确。

Taken from PR #21 with authorship preserved.
deusyu pushed a commit that referenced this pull request Aug 18, 2026
…ness.dyu.sh

站点自建而非合并 PR #21,但吸收其验证过的方案与多个设计想法(VitePress
选型、works 按来源系列分组的信息架构、中文排版细节、部署工作流骨架、
首页六概念卡结构)。

与 #21 的关键差异:
- 侧边栏与首页统计不手写:.vitepress/sidebar.mjs 在构建时从文件系统生成,
  未匹配到分组前缀的新作品落入「社区博客」兜底组——宁可分组不准,
  不可静默丢失
- 自有域名 harness.dyu.sh:base=/、public/CNAME、sitemap/OG/canonical 全量对齐
- 智能体可读:每页伴生同路径 .md 副本 + /llms.txt + /llms-full.txt(Node
  标准库实现,零运行时依赖)
- /feed.xml RSS 2.0,条目时间取自 git 提交历史
- 自有视觉:缰绳青主题 + 缰绳曲线 favicon(与仓库自产海报同一视觉 DNA)
- 部署工作流用 npm ci + Node 22,构建前先跑 sidebar --verify

Design informed by #21.

Suggested-by: Doraemon <159792165+Doraemonblogs@users.noreply.github.com>
deusyu added a commit that referenced this pull request Aug 18, 2026
VitePress 站点:侧边栏/统计由 .vitepress/sidebar.mjs 构建时从文件系统派生(C14),
66 个页面全部带同路径 .md 副本 + llms.txt/llms-full.txt/feed.xml 机器可读出口,
scripts/verify-dist.mjs 在构建后机械断言产物契约(页面一一对应、副本自足、全仓禁
symlink、代码区完整性)。经五轮 codex review + 多轮对抗复核修复:命令注入、symlink
越界、CI 最小权限、链接改写与校验双路径、URL 编码幂等、敏感信息清查。

分组式信息架构与 Pages 工作流骨架吸收自 PR #21。

Co-authored-by: Doraemonblogs <159792165+Doraemonblogs@users.noreply.github.com>
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.

1 participant