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 Docs, Playwright e2e, and getting-started are updated to document the new flow and Reviewed by Cursor Bugbot for commit 0b18b81. 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.
| --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.
4623686 to
0b18b81
Compare
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #995 +/- ##
==========================================
- Coverage 89.60% 88.38% -1.22%
==========================================
Files 197 213 +16
Lines 18418 20043 +1625
Branches 1724 1877 +153
==========================================
+ Hits 16503 17716 +1213
- Misses 1908 2319 +411
- Partials 7 8 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|

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?