feat: make doc-kit friendly for newcomers - #995
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR SummaryMedium Risk Overview Configuration now supports The html generator defaults to generic titles, Reviewed by Cursor Bugbot for commit 4623686. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 4623686. Configure here.
| output: opts.output, | ||
| hasHomepage: Boolean(manifest.homepage), | ||
| }) | ||
| ); |
There was a problem hiding this comment.
Force writes ignored config file
Medium Severity
--force always writes doc-kit.config.mjs instead of replacing the file findExistingConfig found. Cosmiconfig prefers .doc-kitrc* and doc-kit.config.js over .mjs, so the new file can be ignored and the old config keeps winning.
Additional Locations (2)
Reviewed by Cursor Bugbot for commit 4623686. Configure here.
| --git-ref <url> Git ref/commit URL (default: "https://github.com/nodejs/node/tree/HEAD") | ||
| -t, --target [modes...] Target generator modes (choices: "json-simple", "legacy-html", "legacy-html-all", "man-page", "legacy-json", "legacy-json-all", "addon-verify", "api-links", "orama-db", "llms-txt") | ||
| -h, --help display help for command | ||
| --config-file <path> Config file |
There was a problem hiding this comment.
It appears that this part of the modification is redundant with #984.


I'm adding:
serve(Build + Serve + Watch)bootstrap(Detect things like package name, docs path, and create a project)install(Install a generator package based on it's name, e.g.doc-kit install web)Hopefully then new consumers can just
doc-kit bootstrap && doc-kit serveto get their projects up-and-running. wdyt?