[docs] Create documentation for documentation (getting started template, useful tips/tricks)
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 38/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- markdown
- Lĩnh vực
- documentation
Hướng nghiên cứu
Xác định cấu trúc tài liệu dành cho nhà phát triển hiện có và các trang bắt đầu tương tự, sau đó xem xét cách frontmatter và các component như Since, ValidExample và InvalidExample hiện đang được sử dụng. Công việc được hoàn thành khi thêm một hướng dẫn không phụ thuộc phiên bản, bao quát template được yêu cầu, các liên kết và mẹo về frontmatter, các component và các ví dụ về tệp.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
What is the Moodle feature that needs documenting?
For documentation we should document some tips and tricks on getting started, for example:
- a getting started template
- useful markdown frontmatter
- links to the frontmatter docs
- useful components (Since, ValidExample, InvalidExample)
- other useful things (including examples from file, etc.)
Is this documentation specific to a Moodle version?
No
Are you able to provide a patch for this?
Yes - I will create one
- 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
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của moodle/devdocs
-
bug documentation help wanted needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
documentation enhancement help wanted needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
bug documentation help wanted needs-triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 65/100
-
bug documentation good first issue needs-triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
-
bug documentation help wanted needs-triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
Tất cả issue của moodle/devdocs
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
TanStack/tanstack.com#1293 ·