Generification of the API Docs Tooling (Long-Term Goal)

[ovflowd]

One of the goals of this project was that it could be used beyond Node.js. This means that this repository would need to be split into two pieces (or a monorepo)

• The core CLI, parser and generator logic (with built-in generators such as orama, json and others)
  • It also contains a config.json schema for the title of the page, name of the api doc tooling, and other things
  • Linting is also part of this, so is code coverage and loading/progress bars.
  • So should all the pieces that make the tooling "smart" or good to be used/traversed by.
  • Node.js releases and version information + CHANGELOG generation should not be part of this tooling.
  • Should be well documented, including how to add generators and how it works
• The Node.js's pieces (CLI that extends the core CLI, for all our specific stuff, all the generators specific for Node (legacy-html, web, etc)
  • Only generators and extra pieces of the CLI and plugins should take part of this, all the core logic (parsers, asts, etc, shared utils) should be on the core package (as they could be reused by other people using our tooling)

This would allow other projects, such as fastify, expressjs and maybe even other projects outside of the Foundation to use a standardised tooling. For API documentation generation.

[ovflowd]

cc @nodejs/web-infra

[AugustinMauroy]

big +1