Making it easier for DTS consumers

Offen

#441 erstellt am 29.9.2025 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 20/100

Issue-Typ: Feature
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: javascript
Bereich: documentation, tooling

Rechercherichtung

Beginne damit, die Diskussion im ersetzten issue #437 und den Kontext des Web Team Meeting zu lesen. Kläre, welche Dokumentationsbesonderheiten DTS-Maintainer derzeit manuell beheben und ob der AST, ein Generator oder beides sie beheben sollte. Als abgeschlossen gilt, wenn der beabsichtigte Consumer-Workflow und der Umfang definiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

blocked

This was discussed in today's Web Team Meeting.

Supersedes: #437

We'd like to make our AST, and possibly a generator, to make it easy to consume Node.js docs by the DTS maintainers. We want them to have a good DX.

As discussed in today's meeting, this means finding and resolving quirks that require these maintainers to manually scour our documentation, which, on it's own, has many fallacies.

Vorherrschende Sprache: JavaScript
Sterne: 65
Forks: 71
Ø Merge: 4 T. 3 Std.
Gemergte PRs (30 T.): 31

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

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

Mehr aus nodejs/doc-kit

PR-Quality action need to be fixed Offen

Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 68/100

nodejs/doc-kit#1085 · 6 Kommentare · Erstellt am 05.9.2026
inline code "type" didn't have same style everywhere Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100

nodejs/doc-kit#1054 · 1 Kommentar · Erstellt am 26.8.2026
Implement a Remark Linter to validate Semantic Version strings in metadata Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 65/100

nodejs/doc-kit#1109 · Erstellt am 23.9.2026
Can the links to previews in the comments generated by a PR include `doc-kit`? Offen

nodejs/doc-kit#1098 · 2 Kommentare · 1 zugewiesene Person · Erstellt am 14.9.2026
`strong class="critical"` didn't exist on redesigned style Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

nodejs/doc-kit#1056 · 2 Kommentare · Erstellt am 26.8.2026

Alle Issues in nodejs/doc-kit