Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</p>

<p align="center">
<code>api-docs-tooling</code> is a tool to generate API documentation of Node.js. <a href="https://github.com/nodejs/node/issues/52343">See this issue</a> for more information.
<code>@nodejs/doc-kit</code> is a tool to generate API documentation of Node.js. <a href="https://github.com/nodejs/node/issues/52343">See this issue</a> for more information.
</p>

<p align="center">
Expand All @@ -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

Expand All @@ -54,7 +54,7 @@ Commands:
### `generate`

```
Usage: api-docs-tooling generate [options]
Usage: @nodejs/doc-kit generate [options]

Generate API docs

Expand All @@ -74,7 +74,7 @@ Options:
### `lint`

```
Usage: api-docs-tooling lint [options]
Usage: @nodejs/doc-kit lint [options]

Run linter independently

Expand All @@ -90,7 +90,7 @@ Options:
### `interactive`

```
Usage: api-docs-tooling interactive [options]
Usage: @nodejs/doc-kit interactive [options]

Launch guided CLI wizard

Expand All @@ -101,7 +101,7 @@ Options:
### `list`

```
Usage: api-docs-tooling list [options] <types>
Usage: @nodejs/doc-kit list [options] <types>

List the given type

Expand Down
2 changes: 1 addition & 1 deletion bin/cli.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion bin/commands/interactive.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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)) {
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/generators/man-page/template.1
Original file line number Diff line number Diff line change
@@ -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.
.\"
Expand Down
Loading