Skip to content

Generate documentation from comments to GitHub Pages - #44

Merged
langsamu merged 11 commits into
mainfrom
docs
Apr 1, 2026
Merged

Generate documentation from comments to GitHub Pages#44
langsamu merged 11 commits into
mainfrom
docs

Conversation

@langsamu

@langsamu langsamu commented Mar 31, 2026

Copy link
Copy Markdown
Collaborator

This change introduces TypeDoc for generating a documentation site from documentation comments in the source code, as well as automation for deploying it to GitHub Pages using GitHub Actions.

There are inconsequential changes to the source.
Review best conducted commit-by-commit.

While working on this change I had temporarily triggered the action on pull request to observe output, so an interim result is already visible on https://rdf.js.org/wrapper/.

@langsamu langsamu changed the title docs Generate documentation from comments to GitHub Pages Mar 31, 2026
@langsamu
langsamu marked this pull request as ready for review March 31, 2026 17:22

@matthieubosquet matthieubosquet left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice and clean.

We might want to update the Readme’s Background and Wrapping sections as part of this as they are out of date and result in an incorrect homepage: https://rdf.js.org/wrapper/.

@langsamu
langsamu merged commit 2d237b4 into main Apr 1, 2026
11 checks passed
@langsamu
langsamu deleted the docs branch April 1, 2026 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants