Repository navigation
fix: typedoc on main - #3956
Merged
Merged
fix: typedoc on main#3956
Conversation
Register intentionally unexported helper aliases in typedoc.json, map
inherited Kit symbol links, and override two inherited Kit doc comments
whose {@link} targets cannot resolve from this package. Add a Compile
Docs step to the web3.js CI job so --treatWarningsAsErrors stays green.
Refs: DEV-1151
Port the publish and preview GitHub Pages workflows from maintenance/v1.x to the monorepo. Docs are built from packages/web3.js and deployed to the site root and a v3.x/ subdirectory; versioned directories already on the gh-pages branch (v1.x/) are carried over so the two branches no longer overwrite each other's output. Refs: DEV-1151
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Drop the PR preview workflow: the token it needs was never provisioned in this repository and previews have been failing on every PR. Set read-only default token permissions on the publish workflow. Point the external TypeDoc symbol links at the published Kit API reference instead of empty anchors. Refs: DEV-1151
dev-jodee
approved these changes
Sep 26, 2026
dev-jodee
approved these changes
Sep 26, 2026
dev-jodee
left a comment
dev-jodee
left a comment
Collaborator
There was a problem hiding this comment.
typedoc/gh-pages CI setup. All checks passing.
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.
mainsocompile:docspasses & enforces it via a new CI step andjust docs.maintenance/v1.xto the monorepo: every merge tomainpublishes v3 docs to the site root andv3.x/, preserving the existingv1.x/folder ongh-pages.