diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e1168e7..6bc6cf13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Node.js `api-docs-tooling` Contributing Guide +# `@nodejs/doc-kit` Contributing Guide -Thank you for your interest in contributing to the Node.js `api-docs-tooling` project! We welcome contributions from everyone, and we appreciate your help in making this project better. +Thank you for your interest in contributing to the `@nodejs/doc-kit` project! We welcome contributions from everyone, and we appreciate your help in making this project better. ## Table of Contents @@ -26,7 +26,7 @@ Thank you for your interest in contributing to the Node.js `api-docs-tooling` pr ## Getting Started -The steps below will give you a general idea of how to prepare your local environment for the Node.js `api-docs-tooling` project and general steps for getting things done and landing your contribution. +The steps below will give you a general idea of how to prepare your local environment for the `@nodejs/doc-kit` project and general steps for getting things done and landing your contribution. ### Prerequisites diff --git a/README.md b/README.md index 1772c92e..ff9083ca 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@

- api-docs-tooling is a tool to generate API documentation of Node.js. See this issue for more information. + @nodejs/doc-kit is a tool to generate API documentation of Node.js. See this issue for more information.

@@ -32,11 +32,11 @@ Local invocation: ```sh -$ npx api-docs-tooling --help +$ npx doc-kit --help ``` ``` -Usage: api-docs-tooling [options] [command] +Usage: @nodejs/doc-kit [options] [command] CLI tool to generate and lint Node.js API documentation @@ -54,7 +54,7 @@ Commands: ### `generate` ``` -Usage: api-docs-tooling generate [options] +Usage: @nodejs/doc-kit generate [options] Generate API docs @@ -74,7 +74,7 @@ Options: ### `lint` ``` -Usage: api-docs-tooling lint [options] +Usage: @nodejs/doc-kit lint [options] Run linter independently @@ -90,7 +90,7 @@ Options: ### `interactive` ``` -Usage: api-docs-tooling interactive [options] +Usage: @nodejs/doc-kit interactive [options] Launch guided CLI wizard @@ -101,7 +101,7 @@ Options: ### `list` ``` -Usage: api-docs-tooling list [options] +Usage: @nodejs/doc-kit list [options] List the given type diff --git a/bin/cli.mjs b/bin/cli.mjs index ceea09d6..fcf8a7ec 100755 --- a/bin/cli.mjs +++ b/bin/cli.mjs @@ -10,7 +10,7 @@ import list, { types } from './commands/list.mjs'; import { errorWrap } from './utils.mjs'; const program = new Command() - .name('api-docs-tooling') + .name('@nodejs/doc-kit') .description('CLI tool to generate and lint Node.js API documentation'); // Registering generate and lint commands diff --git a/bin/commands/interactive.mjs b/bin/commands/interactive.mjs index de5b24e5..3c855d00 100644 --- a/bin/commands/interactive.mjs +++ b/bin/commands/interactive.mjs @@ -134,7 +134,7 @@ export default async function interactive() { } // Step 4: Build the final command by escaping values - const cmdParts = ['npx', 'api-docs-tooling', name]; + const cmdParts = ['npx', 'doc-kit', name]; const executionArgs = [name]; for (const [key, { flags }] of Object.entries(options)) { diff --git a/package-lock.json b/package-lock.json index 3019fb38..ad2568c5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,10 +1,10 @@ { - "name": "@node-core/api-docs-tooling", + "name": "@nodejs/doc-kit", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@node-core/api-docs-tooling", + "name": "@nodejs/doc-kit", "dependencies": { "@actions/core": "^1.11.1", "@clack/prompts": "^0.11.0", @@ -55,7 +55,7 @@ "yaml": "^2.7.1" }, "bin": { - "api-docs-tooling": "bin/cli.mjs" + "doc-kit": "bin/cli.mjs" }, "devDependencies": { "@eslint/js": "^9.30.1", diff --git a/package.json b/package.json index 329fed86..4c648a68 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@node-core/api-docs-tooling", + "name": "@nodejs/doc-kit", "repository": { "type": "git", "url": "git+https://github.com/nodejs/api-docs-tooling.git" @@ -21,7 +21,7 @@ }, "main": "./src/index.mjs", "bin": { - "api-docs-tooling": "./bin/cli.mjs" + "doc-kit": "./bin/cli.mjs" }, "devDependencies": { "@eslint/js": "^9.30.1", diff --git a/src/generators/man-page/template.1 b/src/generators/man-page/template.1 index 0edab3db..9d2cf658 100644 --- a/src/generators/man-page/template.1 +++ b/src/generators/man-page/template.1 @@ -1,5 +1,5 @@ .\" -.\" This file was generated automatically by the api-docs-tooling tool. +.\" This file was generated automatically by the @nodejs/doc-kit tool. .\" Please do not edit this file manually. Make any updates to cli.md .\" and regenerate the file afterward. .\"