Skip to content

docs: use typedoc default HTML output#59

Merged
2bndy5 merged 4 commits intomainfrom
separate-API-docs
Jul 5, 2025
Merged

docs: use typedoc default HTML output#59
2bndy5 merged 4 commits intomainfrom
separate-API-docs

Conversation

@2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Jul 4, 2025

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).

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.
@2bndy5 2bndy5 added the documentation Improvements or additions to documentation label Jul 4, 2025
@codecov
Copy link

codecov bot commented Jul 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.63%. Comparing base (163b9aa) to head (f3ae6b0).
⚠️ Report is 38 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@2bndy5 2bndy5 merged commit dc7695f into main Jul 5, 2025
43 checks passed
@2bndy5 2bndy5 deleted the separate-API-docs branch July 5, 2025 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant