Skip to content

Commit 9f4f5e8

Browse files
committed
fixes
Signed-off-by: flakey5 <[email protected]>
1 parent e722dad commit 9f4f5e8

File tree

10 files changed

+901
-844
lines changed

10 files changed

+901
-844
lines changed

Makefile

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ test/addons/.docbuildstamp: $(DOCBUILDSTAMP_PREREQS) tools/doc/node_modules
389389
echo "Skipping .docbuildstamp (no crypto and/or no ICU)"; \
390390
else \
391391
$(RM) -r test/addons/??_*/; \
392-
$(call available-node, $(NPX) --prefix tools/doc api-docs-tooling generate -t addon-verify -i doc/api/addons.md -o test/addons/ --skip-lint) \
392+
$(call available-node, $(NPX) --prefix tools/doc doc-kit generate -t addon-verify -i doc/api/addons.md -o test/addons/) \
393393
[ $$? -eq 0 ] && touch $@; \
394394
fi
395395

@@ -829,12 +829,11 @@ out/doc/api: doc/api
829829
# For generating individual doc files instead of all at once
830830
out/doc/api/%.html out/doc/api/%.json: doc/api/%.md tools/doc/node_modules | out/doc/api
831831
$(call available-node, \
832-
$(NPX) --prefix tools/doc api-docs-tooling generate \
832+
$(NPX) --prefix tools/doc doc-kit generate \
833833
-t $(subst .,legacy-, $(suffix $@)) \
834834
-i $< \
835835
--ignore $(skip_apidoc_files) \
836836
-o $(@D) \
837-
--skip-lint \
838837
-c ./CHANGELOG.md \
839838
-v $(VERSION) \
840839
--index doc/api/index.md \
@@ -1360,7 +1359,7 @@ lint-md: lint-js-doc lint-docs | tools/.mdlintstamp ## Lint the markdown documen
13601359
.PHONY: lint-docs
13611360
lint-docs: tools/doc/node_modules
13621361
$(info Running API Doc linter...)
1363-
$(call available-node, $(NPX) --prefix tools/doc api-docs-tooling lint -i doc/api/*.md)
1362+
$(call available-node, $(NPX) --prefix tools/doc doc-kit lint -i doc/api/*.md)
13641363

13651364
run-format-md = tools/lint-md/lint-md.mjs --format $(LINT_MD_FILES)
13661365
.PHONY: format-md

doc/contributing/api-documentation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Node.js API Documentation Tooling
22

33
The Node.js API documentation is generated by an in-house tooling that resides
4-
in the [nodejs/api-docs-tooling](https://github.com/nodejs/api-docs-tooling)
4+
in the [nodejs/doc-kit](https://github.com/nodejs/doc-kit)
55
repository.
66

77
It is accessible in this repository from the `tools/doc` directory, where it is installed as an npm package.
@@ -30,8 +30,8 @@ nightlies or manual for releases) then moves the docs to
3030

3131
**The key things to know about the tooling include:**
3232

33-
1. It can be invoked via npx from the `tools/doc` directory (i.e. `npx --prefix tools/doc api-docs-tooling ...`)
34-
2. Its usage is detailed in the [nodejs/api-docs-tooling README](https://github.com/nodejs/api-docs-tooling/blob/main/README.md).
33+
1. It can be invoked via npx from the `tools/doc` directory (i.e. `npx --prefix tools/doc doc-kit ...`)
34+
2. Its usage is detailed in the [nodejs/doc-kit README](https://github.com/nodejs/doc-kit/blob/main/README.md).
3535
3. The tooling can process multiple files at a time.
3636
4. The tooling uses a set of dependencies as described in the dependencies
3737
section.
@@ -73,7 +73,7 @@ meant to be a guide on how to write documentation for Node.js.
7373

7474
```bash
7575
# cd tools/doc
76-
npx api-docs-tooling
76+
npx doc-kit
7777
```
7878

7979
**OR**
@@ -173,7 +173,7 @@ added: v0.10.0
173173

174174
* Returns: {SomeClass | null} The next `SomeClass` in line.
175175

176-
`SomeClass` must be registered in `https://github.com/nodejs/api-docs-tooling/blob/main/src/constants.mjs` to be properly parsed in `{type}` fields.
176+
`SomeClass` must be registered in `https://github.com/nodejs/doc-kit/blob/main/src/constants.mjs` to be properly parsed in `{type}` fields.
177177

178178
### `SomeClass.someProperty`
179179

doc/contributing/maintaining/maintaining-types-for-nodejs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ As part of the regular build/release process both the `html` and
9797
`json` files are published to [nodejs.org][].
9898

9999
The generator that does the conversion is in the
100-
[nodejs/api-docs-tooling][]
100+
[nodejs/doc-kit][]
101101
repository.
102102

103103
## Markdown structure
@@ -124,5 +124,5 @@ JSON output.
124124
[documentation-style-guide]: https://github.com/nodejs/node/blob/HEAD/doc/README.md#documentation-style-guide
125125
[next-10]: https://github.com/nodejs/next-10/blob/HEAD/meetings/summit-nov-2021.md#suitable-types-for-end-users
126126
[nodejs.org]: https://nodejs.org/en/docs/
127-
[nodejs/api-docs-tooling]: https://github.com/nodejs/api-docs-tooling
127+
[nodejs/doc-kit]: https://github.com/nodejs/doc-kit
128128
[suitable types for end-users]: https://github.com/nodejs/node/blob/HEAD/doc/contributing/technical-priorities.md#suitable-types-for-end-users

test/doctool/test-apilinks.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ fs.readdirSync(apilinks).forEach((fixture) => {
2626
[
2727
'--prefix',
2828
docToolingDir,
29-
'api-docs-tooling',
29+
'doc-kit',
3030
'generate',
3131
'-t',
3232
'api-links',
@@ -45,7 +45,7 @@ fs.readdirSync(apilinks).forEach((fixture) => {
4545
for (const [k, v] of Object.entries(expectedLinks)) {
4646
assert.ok(k in actualLinks, `link not found: ${k}`);
4747
assert.ok(actualLinks[k].endsWith('/' + v),
48-
`link ${actualLinks[k]} expected to end with ${v}`);
48+
`link ${actualLinks[k]} expected to end with ${v}`);
4949
delete actualLinks[k];
5050
}
5151

tools/doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Documentation Tooling
22

3-
The Node.js API documentation tooling lives in [nodejs/api-docs-tooling](https://github.com/nodejs/api-docs-tooling).
3+
The Node.js API documentation tooling lives in [nodejs/doc-kit](https://github.com/nodejs/doc-kit).
44
This module exists just to make it usable in Node.js core, any changes to the tooling should be done in that repository.

tools/doc/get-latest-commit.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env node
22

3-
const res = await fetch('https://api.github.com/repos/nodejs/api-docs-tooling/commits/main', {
3+
const res = await fetch('https://api.github.com/repos/nodejs/doc-kit/commits/main', {
44
headers: {
55
accept: 'application/vnd.github.VERSION.sha',
66
},

0 commit comments

Comments
 (0)