Making it easier for DTS consumers
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 64
- Forks
- 71
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 31
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the discussion in superseded issue #437 and the Web Team Meeting context. Clarify which documentation quirks DTS maintainers currently resolve manually and whether the AST, a generator, or both should address them. Done means the intended consumer workflow and scope are defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100