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

Implement real-time (on-load) updates to API docs live-environment

Đang mở
#327 5 bình luận 1 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
42/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
javascript
Lĩnh vực
documentation, web-dev

Hướng nghiên cứu

Không có tệp mã nguồn hoặc kiểm thử nào được nêu. Hãy bắt đầu bằng cách xác định mã của môi trường live cho tài liệu API, sau đó theo dõi cách các banner và danh sách thả xuống bản phát hành được kết xuất; so sánh các endpoint dữ liệu bản phát hành Node.js hiện có. Được xem là hoàn tất khi việc tải không chặn hỗ trợ các banner toàn cục và theo từng phiên bản, cùng các phiên bản tài liệu mới hơn, mà không làm hỏng tài liệu tĩnh.

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

Mô tả

Web Generator
Enter your suggestions in details:

One of the "flaws" (intentionally designed as-is) of our API docs is that once a release is done, docs cannot be udpated for said release or iterated over. This is due to the nature of our API docs release process and how its hosting is independent and completely static. There are advantages and disadvantages to this model.

For example, one of the disadvantages is, we cannot apply our global announcement banners over the course of time.

This proposal implements a static (resides on this repository or nodejs/node) api-docs.config.json that contains a map of entries for any given version of the Node.js API docs; Where the key is the current "major" the API doc was built and the value are the possible overrides such as:

  • header banners (same mechanism from the website)

And then also global entries (not specific to version-specific changes):

  • header banners (stays on top of the version-based banners)

And then the API Docs can also pool https://nodejs.org/dist/index.json or even https://nodejs.org/en/next-data/release-data to asynchronously completement the release dropdown with newer versions. So that people can navigate to newer versions of the docs.

All this data is loaded asynchronously and non-blocking.


Example structure of api-docs.config.json:

{
  "global": {
    "banner": {
      "startDate": "2025-05-14T03:00:00.000Z",
      "endDate": "2025-05-21T03:00:00.000Z",
      "text": "May Security Release is available",
      "link": "https://nodejs.org/en/blog/vulnerability/may-2025-security-releases",
      "type": "warning"
    }
  }
  "v24": {
    "banner": {
      "startDate": "2025-05-14T03:00:00.000Z",
      "endDate": "2025-05-21T03:00:00.000Z",
      "text": "May Security Release is available",
      "link": "https://nodejs.org/en/blog/vulnerability/may-2025-security-releases",
      "type": "warning"
    }
  }
}
Ngôn ngữ chính
JavaScript
Star
65
Fork
71
Merge trung bình
4 ngày 3 giờ
Pull request đã merge (30 ngày)
31

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 nodejs/doc-kit

Tất cả issue của nodejs/doc-kit

Issue tương tự

Thêm issue về JavaScript

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.