Skip to content

Broken relative links in docs/reference.md (and one in rust-kernel-architecture.md) #361

Description

@lightight

Several relative links in docs/reference.md are written as if resolved from the repository root, but Markdown resolves relative links against the file's own directory, so they currently 404:

  • line 48: [docs/demos.md](docs/demos.md#payment-demo-gate) resolves to docs/docs/demos.md
  • line 199: [docs/api-surface.md](docs/api-surface.md) resolves to docs/docs/api-surface.md
  • line 232: link to docs/governed-data-plane.md — same double-docs/ pattern
  • line 310: link to docs/issue-to-pr.md — same double-docs/ pattern
  • line 76: [CONTRIBUTING.md](CONTRIBUTING.md) resolves to docs/CONTRIBUTING.md, but the file lives at the repository root, so this needs ../CONTRIBUTING.md

The same class of bug appears in docs/rust-kernel-architecture.md line 774, where [docs/trusted-kernel-package-truth.md](../../docs/trusted-kernel-package-truth.md) resolves outside the repository entirely; the target exists at docs/trusted-kernel-package-truth.md, so a ./ prefix would fix it.

All verified by resolving each link relative to its containing file against a fresh clone. Happy to send a PR correcting the paths if that is preferred.

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