esi / esi-docs

The official repository for ESI documentation
MIT License
145 stars 60 forks source link

fix broken doc link #75

Closed KHannel closed 1 year ago

Blacksmoke16 commented 1 year ago

What's actually broken about it? The page is available in both HTML and Markdown formats. What happens if you just remove the extension? Then maybe it'll resolve correctly depending on the context you're viewing the docs on. E.g. GH versus the actual docs website.

KHannel commented 1 year ago

I'm not sure where the page is available in HTML format so I can't say if it's broken there or not but the repository only has the markdown version. The link is broken when viewing the docs through github and the file that's being linked to as "Resolve Structure IDs" (resolve_structure_ids.html) does not exist in the repository.

This is where the "Resolve Structures IDs" link is broken when viewing through github: image

The result when clicking on the "Resolve Structure IDs" link: image

KHannel commented 1 year ago

I found the link in the published HTML docs and it works as expected there. I don't see anything in the repo that generates or converts the markdown to HTML. Can you share how I can generate the HTML or another way I can test if removing the extension works in both places?

CarbonAlabel commented 1 year ago

Using the .md extension is the correct move here. That way, the link works when browsing the source, and the page generator takes care of converting it to .html when compiled.

Thanks for the PR!