Skip to content

Malformed anchor link in generated Wasm docs: LockMetadata links to NotarizationClient.mdupdatemetadata #282

Description

@Thoralf-M

Summary

The auto-generated Wasm/TypeDoc reference docs contain a malformed Markdown anchor link. In LockMetadata.md, the link to NotarizationClient.updateMetadata is missing the # that separates the file from the anchor:

NotarizationClient.updateState and NotarizationClient.updateMetadata.

  • NotarizationClient.mdupdatemetadata (missing #)
  • ✅ should be NotarizationClient.md#updatemetadata (matching the adjacent, correct #updatestate link)

Where it surfaces

These docs are published as wasm.tar.gz and consumed by the IOTA docs site (iotaledger/iota). The docs site builds with Docusaurus' onBrokenLinks: "throw", so this single malformed link fails the entire wiki build.

Found in the 0.1 tarball:
https://s3.eu-central-1.amazonaws.com/files.iota.org/iota-wiki/iota-notarization/0.1/wasm.tar.gz
notarization-docs/docs/wasm/notarization_wasm/classes/LockMetadata.md (line 52)

Impact / current workaround

The IOTA docs repo has added a temporary sed workaround that rewrites the link after download (iotaledger/iota#11814). Once this is fixed at the source and a corrected tarball is published, that workaround should be removed.

Suggested fix

Fix the link generation so the anchor separator (#) is preserved for updateMetadata (and verify no other cross-references drop the #), then regenerate/republish the Wasm docs tarball.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No fields configured for Bug.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions