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 links appear to be broken on the document site. #212

Open
tpgus opened this issue Nov 4, 2024 · 3 comments
Open

Many links appear to be broken on the document site. #212

tpgus opened this issue Nov 4, 2024 · 3 comments

Comments

@tpgus
Copy link
Contributor

tpgus commented Nov 4, 2024

Many links appear to be broken on the document site.

This issue is not page specific, and is seen on multiple pages.

Maybe, it's a problem that occurred after the e885325 commit, but I'm not sure.

@tpgus
Copy link
Contributor Author

tpgus commented Nov 4, 2024

스크린샷 2024-11-04 오후 8 50 22 스크린샷 2024-11-04 오후 8 49 45 스크린샷 2024-11-04 오후 8 51 43

@smallsaucepan
Copy link
Member

Hi @tpgus. Thanks for pointing these out. It's a known issue I haven't had time to fix yet. Would welcome a PR if you have time?

Briefly, these unconverted links are in the documentation for the most recent relase (7.1.0): https://turfjs.org/docs/api/area There might even be a few in the 6.5.0 docs.

Most (or all) of these should be fixed in the "next" documentation - reflecting the latest development code: https://turfjs.org/docs/next/api/area

It should be fairly easy (though a bit tedious) to hand edit the Markdown (MDX) files for the older documentation. Once the older documents are versioned, they're just static files that can be edited like any other Markdown.

For example, copying the [link](url) text from the working version docs/api/area.mdx to the broken version versioned_docs/version-7.1.0/api/area.mdx would resolve the issue next time the website was published.

Alternatively, we can do nothing and when we release 7.2.0 effectively snapshotting the better "next" documentation, the crumby 7.1.0 documentation will become less prominent.

@tpgus
Copy link
Contributor Author

tpgus commented Nov 6, 2024

Thank you @smallsaucepan for your detailed answer.

As you mentioned, it's more of a tedious task rather than a difficult one 😅,
but it definitely seems like a task worth working on.

before correcting the broken links, I have a few questions.

  1. Is it correct that the underlined part of the "bbox" in the image attached above is not subject to correction?
    wasn't it a link before? (Looks like I might have misunderstood.)

  2. Is it okay to fix only the links that are supposed to function as 'link' but are either broken or incorrectly formatted (such as {@link Feature})?
    (in the 'next' document, I noticed that the <ul> tag was removed in the sections describing the 'returns' for each module. However, Would it be okay not to include it in this task.)

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