Skip to content

Docs overhaul: restructure, expand, and standardize#105

Merged
m1ngsama merged 3 commits into
mainfrom
refactor/docs-overhaul
Apr 28, 2026
Merged

Docs overhaul: restructure, expand, and standardize#105
m1ngsama merged 3 commits into
mainfrom
refactor/docs-overhaul

Conversation

@m1ngsama
Copy link
Copy Markdown
Member

@m1ngsama m1ngsama commented Apr 27, 2026

Closes #104

Summary

  • Migrate Chinese-named directories into English-named structure (相关活动举办/process/2025/, 维修日/repair/)
  • Auto-generate archived sidebar from filesystem; add index pages for tutorial/, process/, archived/
  • Expand incomplete documents (CA101, CA102, hardware-establish, os-skills, net-usage, windows-from-scratch, and more)
  • Standardize maintainer info blocks — link @username to GitHub profiles, add placeholder blocks where missing
  • Fix 41 MD036 lint errors, add per-directory markdownlint config for archived/
  • Add build step to CI, separate ci:lint from lint --fix, add sitemap
  • Fix CRLF line endings in pre-commit hook
  • Fix dead links in archived meeting notes

Test plan

  • pnpm run ci:lint passes with 0 errors
  • pnpm run docs:build succeeds
  • Pre-commit hook runs correctly (lint-staged)
  • Review restructured directory layout for clarity
  • Verify expanded document content is accurate (特别是 CA101, CA102, hardware-establish 等技术文档)
  • Check maintainer GitHub profile links resolve correctly
  • Verify index pages render properly on the site

概要 (Chinese)

对文档站进行全面重构:目录迁移、内容补充、质量标准化。

重点关注:

  • 目录结构是否清晰合理
  • 补充的技术文档内容是否准确
  • 维护人 GitHub 链接是否正确
  • 索引页面渲染是否正常

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 27, 2026

Deploying documents with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9da7c80
Status: ✅  Deploy successful!
Preview URL: https://91b14f7d.documents-dq4.pages.dev
Branch Preview URL: https://refactor-docs-overhaul.documents-dq4.pages.dev

View logs

…uality standardization

Restructure the documentation project for clarity, consistency, and completeness:

- Move Chinese-named directories into existing English-named structure
  (相关活动举办/ → process/2025/, 维修日/ → repair/)
- Auto-generate archived sidebar from filesystem instead of manual config
- Expand incomplete documents: CA101, CA102, hardware-establish, os-skills,
  net-usage, windows-from-scratch, apply-for-credits, borrow-classroom,
  event-organization
- Standardize maintainer info blocks: link @username to GitHub profiles,
  add placeholder blocks for documents missing maintainers
- Fix 41 MD036 lint errors (bold-as-heading → proper headings)
- Add per-directory markdownlint config for archived/ (relaxed rules)
- Add build step to CI, separate ci:lint from lint --fix
- Add sitemap, restrict ignoreDeadLinks to external URLs only
- Fix dead links in archived meeting notes
- Add index pages with content listings for tutorial/, process/, archived/
- Fix CRLF line endings in pre-commit hook
Fix 20 prettier/eslint errors (table column alignment) in the newly
merged reimbursement-process document from PR #103.
@m1ngsama m1ngsama enabled auto-merge (squash) April 27, 2026 08:52
@Yuna-Celisse
Copy link
Copy Markdown
Contributor

LGTM

Yuna-Celisse

This comment was marked as off-topic.

@m1ngsama m1ngsama merged commit 8c713c8 into main Apr 28, 2026
5 checks passed
@m1ngsama m1ngsama deleted the refactor/docs-overhaul branch April 28, 2026 15:11
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.

Docs overhaul: restructure, expand content, and standardize quality

2 participants