RobotWebTools / rclnodejs / 23330152786

86%

push

github

Move JSDoc tooling under tools/jsdoc and document publish workflow (#1447)

- add a dedicated JSDoc toolchain under tools/jsdoc, including the custom template, static assets, landing-page generator, and gh-pages staging script
- switch `npm run docs` to build local versioned docs through tools/jsdoc
- add `docs:gh-pages` to stage published docs by preserving the currently published history from `origin/gh-pages` and regenerating the current workspace version
- add `docs:gh-pages:full` to fully rebuild only the published docs subset from tags, instead of rebuilding every historical release tag
- generate the staged docs landing page automatically from the version directories present in the docs output
- hoist shared staged assets into `build/gh-pages-docs/docs/_static` and keep `.nojekyll` for publishing compatibility
- clarify the maintainer workflow in [tools/jsdoc/README.md](/home/minggang/proj/rclnodejs/tools/jsdoc/README.md), including local docs builds, staged gh-pages builds, full published-history rebuilds, and manual landing-page regeneration
- make small JSDoc comment fixes in [lib/subscription.js](/home/minggang/proj/rclnodejs/lib/subscription.js) and [lib/timer.js](/home/minggang/proj/rclnodejs/lib/timer.js) to improve generated API docs

Fix: #1446

1477 of 1866 branches covered (79.15%)

Branch coverage included in aggregate %.

3036 of 3382 relevant lines covered (89.77%)

455.89 hits per line