Question: organization of documentation

Đang mở
#355 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Issue đề cập đến tài liệu orientjs, tài liệu driver và các chú thích theo kiểu JSDoc, nhưng không nêu tệp hoặc bài kiểm thử nào. Hãy bắt đầu bằng việc xác định các khu vực tài liệu đó và làm rõ liệu tài liệu được quản lý phiên bản trong repository cùng các chữ ký được tạo có nằm trong phạm vi hay không; công việc được xem là hoàn tất khi đã thống nhất bố cục tài liệu và phương pháp tạo.

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

Mô tả

Is there a reason why the docs are store separately from the codebase?

Would you consider storing the docs for each repo with the code itself? At least for the drivers? It would be easier to tell what code works for what version then. In particular, this is currently a bit difficult when using the orientjs docs.

It would also be nice to have jsdoc style comments that could auto-generate docs. Then it would be easier to see function signatures etc.

If this is something you'd like to do I would be happy to help/contribute

Ngôn ngữ chính
CSS
Star
59
Fork
164
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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 orientechnologies/orientdb-docs

Tất cả issue của orientechnologies/orientdb-docs

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.