[Docs] Align production build instructions with the current repository

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#17 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
65/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation, release

Hướng nghiên cứu

Bắt đầu từ phần build production trong docs/DEVELOPMENT.md, phần này vẫn tham chiếu đến EncryptHome.spec. Kiểm tra các tệp đang được theo dõi ở thư mục gốc của repository để xác nhận tệp spec đó có tồn tại hay không, và so sánh các lệnh dành cho phiên bản cụ thể với cấu trúc dự án hiện tại. Công việc được xem là hoàn tất khi các bước không còn giả định rằng tệp spec có sẵn, điều kiện tiên quyết còn thiếu được đánh dấu rõ ràng, và hướng dẫn phát triển cùng phát hành vẫn dễ hiểu đối với người mới.

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

Mô tả

documentation good first issue

Summary

The production-build section in docs/DEVELOPMENT.md still refers to an unavailable EncryptHome.spec file and includes version-specific commands that do not match the current checkout. This can mislead first-time contributors trying to build the application.

Proposed solution

Update the build and release instructions to describe the repository's actual state. Clearly mark the missing PyInstaller spec as a prerequisite, remove stale version-specific examples, and keep the documented commands consistent with the files currently tracked in the repository.

Acceptance criteria

  • The documented production-build steps do not assume a missing spec file exists.
  • Version examples and commands are consistent with the current project layout.
  • Development setup and release instructions remain understandable for newcomers.

Security considerations

Documentation-only change; do not alter encryption, authentication, or vault behavior.

Additional context

Relevant file: docs/DEVELOPMENT.md.

Ngôn ngữ chính
Python
Star
1
Fork
0
Merge trung bình
2 giờ 7 phút
Pull request đã merge (30 ngày)
6

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

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 ANCORATE/EncryptHome

Tất cả issue của ANCORATE/EncryptHome

Issue tương tự

Thêm issue về Python

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.