Skip to content

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

Description

@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.

Activity

  1. added theissue type on Jul 1, 2025
  2. ovflowd commented on Jul 1, 2025

    @ovflowd
    MemberAuthor

    cc @nodejs/web-infra

  3. AugustinMauroy commented on Jul 1, 2025

    @AugustinMauroy
    Member

    big +1

  4. bjohansebas commented on Jul 8, 2025

    @bjohansebas
    Member

    Big +1

  5. pinned this issue on Aug 15, 2025
  6. self-assigned this
    on Feb 5, 2026
  7. avivkeller commented on Feb 5, 2026

    @avivkeller
    Member

    Working on adding a doc-kit config file

  8. unpinned this issue on Feb 7, 2026
  9. linked a pull request that will close this issuefeat(cli): add a configuration file option #593on Feb 7, 2026
  10. avivkeller commented on Feb 14, 2026

    @avivkeller
    Member

    @ovflowd Is this not resolved by the config file?

  11. ovflowd commented on Feb 22, 2026

    @ovflowd
    MemberAuthor

    @ovflowd Is this not resolved by the config file?

    Yeah, there are still other items :)

  12. avivkeller commented on Jun 19, 2026

    @avivkeller
    Member

    Good news! With webpack working, we now have proof that the docs are generic enough for use outside Node.js!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions