benjamn / benjamn/ast-types

Automatically generate HTML namedTypes/builders documentation from the declarations in def/*.js

Open
#37 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
1.2k
Forks
194
Avg merge
22h 43m
Merged PRs (30d)
10

Description

We already use the `def` syntax to generate AST types and builders automatically, so it would be awesome if we also generated documentation at https://benjamn.github.io/ast-types/documentation, or something like that.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the declarations in def/*.js and the existing AST type and builder generation described in the issue. Determine how documentation should be generated and published at the ast-types documentation URL. Done means the namedTypes/builders documentation is automatically produced from those declarations.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.