Skip to content

Issue with absolute links in docs #1230

@tsmbland

Description

@tsmbland

We use absolute links quite a lot to point to different places in the documentation. In some places this is necessary because we need to point to pages that are built by scripts (i.e. don't have an md file), and we want links to work from both md files and html files (the link checker enforces this).

One issue with this is that these absolute links all point to the latest version of the documentation. If you're browsing the documentation for an earlier release, then clicking one of these links will take you out of that version and over to the latest version of the docs (if that page exists, which indeed it may not).

We briefly discussed ideas, and one solution would be to do a find and replace when building doc versions to update these links so that they point to the documentation version in question. (With the caveat that links in release notes should probably always point to the documentation for that release, regardless of where you're coming from). There are also some links in rust files so we should ideally update these too to make sure links in the API docs are correct.

Other ideas are welcome

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    📋 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions