Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation links broken #36

Open
harmboschloo opened this issue May 24, 2019 · 2 comments
Open

documentation links broken #36

harmboschloo opened this issue May 24, 2019 · 2 comments

Comments

@harmboschloo
Copy link

In Quantity.elm there are a number of links to #multiplication-and-division, but that tag doesn't exist.

Note that there are [other forms of multiplication](/#multiplication-and-division)!

@ianmackenzie
Copy link
Owner

Argh, good catch, thanks! I think that probably worked when previewing docs locally but doesn't work on the actual Elm package site. The intent is to link to

https://package.elm-lang.org/packages/ianmackenzie/elm-units/latest/#multiplication-and-division

(a section of the README) but using a link of /#multiplication-and-division from

https://package.elm-lang.org/packages/ianmackenzie/elm-units/latest/Quantity

leads to

https://package.elm-lang.org/#multiplication-and-division

instead, which obviously doesn't work. Using #multiplication-and-division (without the slash) also won't work since that will presumably try to link to

https://package.elm-lang.org/packages/ianmackenzie/elm-units/latest/Quantity#multiplication-and-division

Now that I look more closely, though, even the desired link doesn't work since the Elm package site doesn't seem to support directly linking to an anchor (clicking on an anchor link within the README once it's loaded works fine, but not entering it in the URL - logged as elm/package.elm-lang.org#304). So there may not be a nice way to do it...might have to refactor the documentation to move that section from the README to the Quantity module page instead.

@ianmackenzie
Copy link
Owner

I'm actually also currently working on a framework for making nice 'guides' for Elm packages (with code examples, inline interactive demos etc.). So perhaps the best solution is to move much of the high-level explanatory content that is currently in the README to a separate guide, and then link to that from the README/module documentation pages etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants