Conversation
This transitions the node binding's API docs to use typedoc's default HTML output. Most hyperlinks to node binding's API docs' remain intact (compared to previous deployments on npm.org). I'm not overly excited about the typedoc organization of the API members, but at least they look familiar to node.js devs that are accustomed to reading typedoc-generated docs. I also found some typos in the doc comments during local review, so there are some fixes in the docs' content also.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
===========================================
- Coverage 100.00% 99.63% -0.37%
===========================================
Files 22 22
Lines 3250 2734 -516
===========================================
- Hits 3250 2724 -526
- Misses 0 10 +10 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2bndy5
commented
Jul 4, 2025
also fixes some spellings and ignores certain paths
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This transitions the node binding's API docs to use typedoc's default HTML output. See this PR's RTD build.
Most hyperlinks to node binding's API docs' remain intact (compared to previous deployments on npm.org).
I'm not overly excited about the typedoc organization of the API members, but at least they look familiar to node.js devs that are accustomed to reading typedoc-generated docs.
I also found some typos in the doc comments during local review, so there are some fixes in the docs' content also.
Lastly, I added a pre-commit hook to check spellings in changed files (or all files if using
pre-commit run --all-files).