Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen
  • Stimmt etwas nicht?
#327 5 Kommentare 1 Reaktion 1 zugewiesene Person Auf GitHub ansehen

Maintainer antworten meist innerhalb von 3 Tagen

@avivkeller arbeitet bereits daran.

Seit 24.9.2026.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
42/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
javascript
Bereich
documentation, web-dev

Rechercherichtung

Es werden keine Quelldateien oder Tests genannt. Beginne damit, den Code für die Live-Umgebung der API-Dokumentation zu lokalisieren, und verfolge dann, wie Banner und das Release-Dropdown gerendert werden; vergleiche die verfügbaren Node.js-Release-Daten-Endpunkte. Als abgeschlossen gilt die Aufgabe, wenn das nicht blockierende Laden globale und versionsspezifische Banner sowie neuere Dokumentationsversionen unterstützt, ohne die statische Dokumentation zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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"
    }
  }
}
Vorherrschende Sprache
JavaScript
Sterne
65
Forks
71
Ø Merge
4 T. 55 Min.
Gemergte PRs (30 T.)
31

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus nodejs/doc-kit

Alle Issues in nodejs/doc-kit

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.