Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[chore] Restructure developer docs

Đang mở
#855 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
20/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem xét cấu trúc tài liệu được quản lý theo phiên bản, đặc biệt là Developer Guides, Core APIs, Plugin Types và Subsystems. So sánh vị trí hiện tại của các API như Output, bao gồm format_string và format_text, trong tài liệu và xác định cách chúng nên được sắp xếp lại. Công việc được xem là hoàn tất khi đã thống nhất một cấu trúc với các hướng dẫn rõ ràng hơn và các liên kết đến tài liệu đang được cập nhật thay vì các chữ ký hàm tĩnh.

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

Mô tả

help wanted needs-triage repo
What do we need to do?

When we started the devdocs we tried to consider to structure our existing content better.

We have, largely speaking, achieved that. However, the current structure is still somewhat confusing.

flowchart TD
    C[Versioned documentation]
    C --> GUIDES[Developer Guides]
    C --> API[API Guides]
    API --> FILES[Common files]
    API --> CORE[Core APIs]
    API --> PLUGIN[Plugin Types]
    API --> SUBSYSTEM[Subsystems]
    C --> DEVUP[Developer Updates]

Within each of API guide sections we have a fairly large list of APIs and information, and it isn't always clear which location docs should be in. For example, the Output API documentation which covers critical methods such as {{format_string}}, and {{format_text}} are under Subsystems, but arguably these shoudl be uder "Core APIs". For most people APIs such as these subsystem APIs are so critical to the daily development of Moodle that their categorisation as a subsystem is confusing when compared to a subsystem such as Task, Editor, Privacy, Check, Availability, etc.

I think we need to find a way to reduce these restructure some of these categories, and perhaps toimprove our "Developer guides" too.

Many of the se Core API and Subsystem docs would be better served as guides. It is not in our interest to store API documentation in any static form with function signatures in these docs. We should find better ways to link to the live documentation instead.

Ngôn ngữ chính
TypeScript
Star
74
Fork
652
Merge trung bình
2 ngày 50 phút
Pull request đã merge (30 ngày)
12

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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 moodle/devdocs

Tất cả issue của moodle/devdocs

Issue tương tự

Thêm issue về TypeScript

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.