docs: tolerate missing Node API docs declarations#94
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📜 Recent review details🧰 Additional context used📓 Path-based instructions (2){.github/**/*.{yml,yaml},*.patch,scripts/**/*,*.sh,*.bat,Dockerfile*}📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Files:
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (1)
WalkthroughThe build script now determines which Node API documentation modules are available by checking whether their TypeDoc declaration artifacts exist. The ChangesModule availability and pipeline threading
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
|
/merge |
Overview
Make the Node.js API docs artifact builder tolerate optional declaration files that are absent when sphinx-multiversion builds older release tags.
Details
index.d.tsartifact required so a broken Node package build still fails loudly.observability.d.tsin the0.1.0tag, instead of throwingENOENTduring multi-version docs builds.Validation:
node --check scripts/docs/build_node_docs_artifacts.mjsjust docs-github-pagesSKIP=lychee git commit -s -m "docs: tolerate missing Node API docs declarations"because the commit hook's docs markdown linkcheck failed on pre-existing generated Rust API links unrelated to this change.Where should the reviewer start?
Start with
scripts/docs/build_node_docs_artifacts.mjs, especially the newavailableModules()filtering path and the places that now pass the filtered module list through staging, entrypoint generation, and page rendering.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit