Repository navigation
fix(docs): restore the documentation build - #659
Merged
Merged
Conversation
The example declared tx without a value, and docgen runs each example, so it stopped with "tx is not defined". The example now constructs an empty transaction.
MDX reads braces as an expression and stopped at the @ of {@link Name}.
The copy step now writes each such tag as `Name`.
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
1 participant
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.
Deploy Documentation has failed on every main commit since #606 (October 7). The site build stopped with
Unexpected character '@'on the nine module pages whose JSDoc uses{@link Name}, because MDX reads braces as an expression. Since #652, docgen stops earlier withtx is not defined: thewithCodecOptionsexample declaredtxwithout a value, and docgen runs each example.The example now constructs an empty transaction. The copy step writes each
{@link Name}tag as inline code, so the JSDoc keeps its editor links and the site builds all 324 pages.