Problem/Motivation

In the autogenerated API docs, many inline links lead to 404s.

Steps to reproduce

See https://project.pages.drupalcode.org/api_client/api/drupal-api-client/ap...

An example 404 link is: https://project.pages.drupalcode.org/api_client/api/drupal-api-client/ap...

The md file extension shouldn't be there, and it almost seems like it is using relative links when it shouldn't.

I'm not sure if the Starlight TypeDoc plugin is to blame https://github.com/HiDeoo/starlight-typedoc or perhaps typedoc-plugin-markdown itself https://github.com/tgreyuk/typedoc-plugin-markdown

Issue fork api_client-3433018

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

brianperry created an issue. See original summary.

coby.sher’s picture

coby.sher commented
Assigned: Unassigned » coby.sher

Going to start poking at this.

brianperry’s picture

brianperry
he/him
commented
Parent issue: » #3436770: [Meta] Post-1.0 Fast Follow Documentation
brianperry’s picture

brianperry
he/him
commented

We opened this issue in the starlight-typedocs repo: https://github.com/HiDeoo/starlight-typedoc/issues/32

coby.sher’s picture

coby.sher commented

I see others reporting the same issue on GitHub and the maintainer is looking for a minimal reproduction. I'll work on making that available.

coby.sher’s picture

coby.sher commented

https://github.com/HiDeoo/starlight-typedoc/issues/40#issuecomment-20618...
I was able to reproduce some broken link behavior with a minimal monorepo so hopefully the maintainer can fix or we can understand how we are holding it wrong :)

coby.sher’s picture

coby.sher commented

The maintainer fixed part of the issue in a new release, however upon installing that version and trying it with our docs I still see some broken links.
I'm going to try to update my reproduction to capture these cases. Lucky for us the maintainer of that plugin has been very responsive.

coby.sher’s picture

coby.sher commented

Our issue might have to do with our typedoc declarations. I'll look into that first: https://typedoc.org/guides/declaration-references/#module-source

coby.sher opened merge request !121

coby.sher’s picture

coby.sher commented
Assigned: coby.sher » Unassigned
Status: Active » Needs review
brianperry’s picture

brianperry
he/him
commented
Status: Needs review » Fixed

Latest MR does in fact fix it. Awesome! Deployed the updated docs and everything is working as expected: https://project.pages.drupalcode.org/api_client/api/drupal-api-client/ap...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.