Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create api-tooling repository #866

Closed
ovflowd opened this issue May 2, 2024 · 9 comments
Closed

Create api-tooling repository #866

ovflowd opened this issue May 2, 2024 · 9 comments

Comments

@ovflowd
Copy link
Member

ovflowd commented May 2, 2024

As described on nodejs/node#52343 we want to create a new repository to keep the actual tooling of the API docs, and keep it separated from core, so that its development is unrelated to the core itself (which IMO makes sense)

The goal for the tooling repository is to:

  • Provide the source of a tooling system (similar to the existing one, but revamped) for building the API docs
    • The build system behind the tooling will be discussed within the new repository, but so far, the stack I'm foreseeing is:
      • Vite as the Build System for the API Tooling (Which also supports built-in DevServer and HMR, etc)
        • Works on top of ESBuild
      • A JSX Library, such as React (preferably React), which is going to be used for crafting the templates, layouts, and components of the API Docs
        • We aim to follow the same approach as the Node.js Website by converting the existing HTML/JavaScript/CSS code into React and then iterating on its design.
      • MDXv3 for parsing the Markdown sources and generating JSX
      • And other components as on the Node.js Website, such as Tailwind, Radix UI, Shiki, etc)
  • Provide a native way of generating the docs with output formats (by creating a rich "bundling system"), where the output formats can be JSON, MDX and HTML
  • Construct a solid Developer Experience and documentation for the Node.js API Docs Tooling
  • Create a foundation for the future of the API Docs, so we're able to redesign it, further add features (such as search), and other relative improvements.

cc @nodejs/tsc (and the @nodejs/web-infra and @nodejs/web-standards, since I want to consult regarding the tech stack above, and since the Web Infra would be the primary "code owners" besides Core Collaborators)

@targos
Copy link
Member

targos commented May 2, 2024

I suggest a more precise name: api-docs-tooling.

@mhdawson
Copy link
Member

mhdawson commented May 2, 2024

+1 from me and I also like the name suggested by @targos

@benjamingr
Copy link
Member

+1 from me (+ the naming suggestion)

@ovflowd
Copy link
Member Author

ovflowd commented May 3, 2024

+1 for the suggested name, thanks @targos!

@mcollina
Copy link
Member

mcollina commented May 6, 2024

+1

@ovflowd
Copy link
Member Author

ovflowd commented May 11, 2024

Hey y'all 👋 can the repository be created? 👀

@benjamingr
Copy link
Member

I've created the repository and gave @nodejs/web-infra write access https://github.com/nodejs/api-docs-tooling/

Please add the regular documents (LICENSE, README, CODE_OF_CONDUCT and CONTRIBUTING).

Also I am explicitly giving you permission as a TSC member to use your org ownership powers (granted as moderator) to perform non-moderation org-admin actions in that repo so you can add/edit access at https://github.com/nodejs/api-docs-tooling/settings/access , edit description etc.

@aduh95
Copy link
Contributor

aduh95 commented May 11, 2024

Also I am explicitly giving you permission as a TSC member to use your org ownership powers (granted as moderator) to perform non-moderation org-admin actions in that repo so you can add/edit access at https://github.com/nodejs/api-docs-tooling/settings/access , edit description etc.

We usually grant "Maintain" role to the team that "owns" the repo, so it doesn't require org admin privileges to operate.

@ovflowd
Copy link
Member Author

ovflowd commented May 12, 2024

Appreciate it, @benjamingr! (and thx for the memo, Antoine!) I'll start preping the repository probably today and start working on the tooling tmrw :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants