fix(readme): preview setup changes into a directory the clone command does not create

Đang mở Phù hợp với người mới
#649 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
88/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
git
Lĩnh vực
documentation

Hướng nghiên cứu

Sự không khớp nằm trong README.md, ở chuỗi xem trước cục bộ quanh các dòng 9-24: lệnh clone git clone --recursive https://github.com/rustdesk/doc.rustdesk.com.git tạo doc.rustdesk.com, nhưng bước tiếp theo chạy cd docs.rustdesk.com. Hãy quyết định nên đổi lệnh clone hay đích của cd để chúng khớp nhau, và kiểm tra phần còn lại của chuỗi xem có cùng tên này không. Hoàn thành khi việc clone mới vào một thư mục trống, theo sau là cd đã được tài liệu hóa, thành công và đưa bạn vào kho lưu trữ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Summary

The README's local preview instructions clone this repository without specifying a destination directory, then run cd docs.rustdesk.com. Git creates doc.rustdesk.com, so the documented directory-change step fails in a fresh parent directory before the reader can start Hugo.

Steps to reproduce

  1. In a new empty parent directory, clone the repository without specifying a destination directory. The README uses git clone --recursive https://github.com/rustdesk/doc.rustdesk.com.git.
  2. Run the README's next command: cd docs.rustdesk.com.

The local reproduction used git clone --depth 1 --no-checkout https://github.com/rustdesk/doc.rustdesk.com.git to observe Git's default destination without setting up submodules or the site. It then executed the documented directory-change command. The recursive clone and Hugo startup were not run.

Expected behavior

The README's “Change to the folder” step should enter the repository directory created by its immediately preceding clone command, allowing the following local-preview step to run from that checkout.

Actual behavior

The clone reported Cloning into 'doc.rustdesk.com'.... The documented directory-change command then failed:

zsh:cd:1: no such file or directory: docs.rustdesk.com

Its exit status was 1. As a control, cd doc.rustdesk.com && test -d .git succeeded with exit status 0 in the same parent directory. No Hugo build or server was started.

Runtime or environment

  • Documentation: master at 56f9310ca2c91f8e94b6a460290d1e94f62e0482 in a fresh clone.
  • Reproduction: Git HTTPS clone and a zsh -f directory-change command in an empty disposable parent directory.

Evidence

  • Expected source: The README local-preview sequence explicitly follows cloning with changing into the folder and starting Hugo.
  • Failure source: The documented clone URL has basename doc.rustdesk.com.git, while the next command uses docs.rustdesk.com; the local clone and shell output above reproduce the mismatch.
  • Evidence provenance: observed
  • Local verification: reproduced
  • Reproduction completeness: complete

Clone destination, failing directory-change command, and successful control were directly observed.

The directory-selection failure was reproduced using a shallow clone without checkout. The full recursive clone and Hugo preview were not tested.

Restoration check

In a new empty parent directory, use the documented clone and directory-change steps. Pass when the directory-change command succeeds and the working directory is the newly cloned repository. This check concerns the directory-selection step; starting Hugo is a separate step and was not verified here.

References

PR #540 revised the README's preview instructions and was merged, but preserved the directory-name mismatch. The current report concerns that remaining failing step; it does not request a comment on the closed PR.

Triage assessment

  • Impact level: P2
  • Assessment status: supported
  • Impact basis: The documented fresh-clone preview sequence stops at the directory-change command. The failure is bounded to readers following that setup sequence and has a directly verified workaround.
  • Workaround status: available
  • Workaround basis: Changing into doc.rustdesk.com succeeded and verified the cloned Git directory in the same reproduction. This restores the directory-selection step without requiring a documentation change or extra permissions.
Ngôn ngữ chính
HTML
Star
822
Fork
720
Merge trung bình
2 giờ 8 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của rustdesk/doc.rustdesk.com

Tất cả issue của rustdesk/doc.rustdesk.com

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.