Skip to content

Make dead links warnings #293

@norswap

Description

@norswap

We're auto-generating some of our docs, including bringing typedoc-generated docs into our vocs site. Unfortunately, this can create dead links that are outside our control, causing the build to fail.

I can also see this being problematic if the docs site is supposed to link out to other pages that are generated or deployed separately.

Funnily enough, the one case comes from Viem, as we return a Viem config from a function and typedoc pulls in the entire documentation for the return value. The offending link is a relative link in the docs of getFilterChanges. All the other links we inherit from the Viem docs are prefixed with https://viem.sh and don't cause issues.

The simple fix here would be to make dead links a warning instead of an error, or to have an option to control the behaviour.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions