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

Many "404 File not found" errors for links in API docs #1175

Open
h-h-h-h opened this issue Apr 3, 2022 · 5 comments
Open

Many "404 File not found" errors for links in API docs #1175

h-h-h-h opened this issue Apr 3, 2022 · 5 comments

Comments

@h-h-h-h
Copy link
Contributor

h-h-h-h commented Apr 3, 2022

Describe the bug
In the API docs under https://moment.github.io/luxon/api-docs/index.html, there are many invalid links. This isn't exhaustive; it's just an example.

To Reproduce

Actual vs Expected behavior

Desktop (please complete the following information):

  • OS: Windows
  • Browser: Firefox
  • Luxon version: N/A
  • Your timezone: N/A

Additional context
See also duplicate #1163.

@icambron
Copy link
Member

Yeah, a lot of these broke when we changed doc systems, and I just haven't tracked them all down

@sam-s4s
Copy link

sam-s4s commented May 5, 2022

Was just about to post this issue. I'm in the process of switching over from moment to luxon, and I keep clicking on all the dead links :P

I'm happy to help update links if someone points me in the right direction?

@icambron
Copy link
Member

icambron commented May 9, 2022

@sam-s4s The doc files are here: https://github.com/moment/luxon/tree/master/docs

A good link looks like this:

[time zones documentation](zones.md?id=math-across-dsts)

which works both in Github and the rendered site

@sam-s4s
Copy link

sam-s4s commented May 9, 2022

-Edited-
So it looks like the api-docs are using JSDoc, but interestingly the "correct" links and the "incorrect" links look the same. I wonder if the docs just need regenerating?
ie...
{@link DateTime#local} = https://moment.github.io/luxon/api-docs/DateTime#local
{@link DateTime#weekYear} = https://moment.github.io/luxon/api-docs/index.html#datetimeweekyear

@elliott-king
Copy link
Contributor

It looks like all non-sidebar links to static members are not working.

Example of failing links (static Datetime members within docs page):
Screen Shot 2022-07-08 at 9 36 13 AM

Example of failing links (static Duration members within docs page):
Screen Shot 2022-07-08 at 9 36 35 AM

Example of successful links (static Duration members in sidebar):
Screen Shot 2022-07-08 at 9 37 12 AM

Example of successful links (instance Duration members within docs page):
Screen Shot 2022-07-08 at 9 37 52 AM

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

No branches or pull requests

4 participants