Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#327 コメント 5 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
42/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
javascript

調査の方向性

ソースファイルやテストは指定されていません。まず API ドキュメントのライブ環境コードを見つけ、次にバナーとリリースのドロップダウンがどのようにレンダリングされるかを追跡します。利用可能な Node.js リリースデータのエンドポイントを比較してください。完了条件は、ノンブロッキングな読み込みによってグローバルバナーとバージョン固有のバナー、およびより新しいドキュメントバージョンをサポートし、静的ドキュメントを壊さないことです。

索引モデルが issue の本文から書いたものです。

説明

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"
    }
  }
}
主要言語
JavaScript
スター
65
フォーク
71
平均マージ
4日 3時間
マージ済み PR(30日)
31

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nodejs/doc-kit のほかの issue

nodejs/doc-kit の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。