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

【Proposal】Building a Better Next-Generation TypeScript Documentation Experience

Đang mở
  • Có gì không ổn?
#3,583 3 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
documentation, web-dev

Hướng nghiên cứu

Bắt đầu bằng việc xem xét issues/2804 và issues/3377, sau đó so sánh bản dựng lại VitePress được liên kết với tài liệu TypeScript hiện tại. Đề xuất xác định các liên kết bị hỏng, HTML trộn lẫn trong Markdown và nội dung được chèn bởi script, nhưng không nêu tệp nào trong repository hoặc các bài kiểm thử. Để hoàn tất, cần có sự thống nhất của nhóm về phạm vi và một kế hoạch migration cụ thể.

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

Mô tả

I previously shared my suggestions here: issues/2804#issuecomment-3567600241. More than half a year has passed, yet I still haven't seen any official response from the team regarding documentation improvements. I can understand that the main focus may currently be on the arrival of TS 7.x rather than the documentation side of things, so I decided to move forward with this myself.

I rebuilt the documentation using vitepress, and the result is available at: tslang.org. Compared to typescriptlang.org, the overall user experience has improved significantly.

In particular, regarding the TypeScript tsconfig reference page, I also noticed that users have already raised complaints about it in issues#3377.

Current problems with the official documentation:

  1. There are many broken links that still haven't been fixed.

  2. Some markdown files contain a large amount of mixed HTML syntax such as tables, and many HTML tags are not even properly closed.

A large portion of this content is dynamically injected into markdown files through scripts. In practice, documentation should avoid this approach whenever possible. All content should be written directly in the documentation itself, which makes long-term maintenance much easier.

At the moment, the source code for this documentation project is hosted in my private repository. If the TypeScript team believes this documentation aligns with the vision and needs of a next-generation documentation experience, I would be willing to transfer the repository to the official project.

Once the official team agrees to move forward with this direction, issues#2804 can finally proceed to the next stage.

Ngôn ngữ chính
TypeScript
Star
2.6k
Fork
1.5k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
7

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

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. 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 microsoft/TypeScript-Website

Tất cả issue của microsoft/TypeScript-Website

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.