Making it easier for DTS consumers
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 65
- Forks
- 71
- Ø Merge
- 2 T. 17 Std.
- Gemergte PRs (30 T.)
- 31
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100