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

404 Error on 'Doc Examples' Link in Cmarkit Section #2899

Open
labdhiongithub7 opened this issue Dec 28, 2024 · 5 comments
Open

404 Error on 'Doc Examples' Link in Cmarkit Section #2899

labdhiongithub7 opened this issue Dec 28, 2024 · 5 comments

Comments

@labdhiongithub7
Copy link
Contributor

This issue pertains to a broken link in the cmarkit section of the application or website. When users click on the "doc examples" link, instead of navigating to the intended resource or page, it results in a 404 error. This indicates that the linked page is either missing, has been moved, or the URL is incorrect. The problem affects user experience by preventing access to the expected documentation or examples.
Screenshot 2024-12-28 163821

@github-project-automation github-project-automation bot moved this to 📋 Backlog in OCaml.org Dec 28, 2024
@labdhiongithub7 labdhiongithub7 changed the title "404 Error on 'Doc Examples' Link in Cmarkit Section" 404 Error on 'Doc Examples' Link in Cmarkit Section Dec 28, 2024
@labdhiongithub7
Copy link
Contributor Author

labdhiongithub7 commented Jan 8, 2025

CC @cuihtlauac @sabine

@vit0rr
Copy link

vit0rr commented Jan 24, 2025

This indicates that the linked page is either missing, has been moved, or the URL is incorrect

For some reason, the Github README is not correctly parsed. The package description page in ocaml.org is just a view from the project's README. All links were working when I tried using Github directly.

It is redirecting to https://ocaml.org/p/cmarkit/test/bench.ml instead of https://github.com/dbuenzli/cmarkit/blob/main/test/bench.ml

I'll try to debug it

@labdhiongithub7
Copy link
Contributor Author

labdhiongithub7 commented Jan 25, 2025

Hello @vit0rr ! Could you please elaborate how did you accessed the links directly from Github?

@vit0rr
Copy link

vit0rr commented Jan 26, 2025

Hello @vit0rr ! Could you please elaborate how did you accessed the links directly from Github?

You can just access the project's Github page: https://github.com/dbuenzli/cmarkit

@cuihtlauac
Copy link
Collaborator

For some reason, the Github README is not correctly parsed. The package description page in ocaml.org is just a view from the project's README. All links were working when I tried using Github directly.

ocaml.org copies README from their project's home page in GitHub.

When files include relative links, they are not resolved correctly once displayed in ocaml.org. For instance, here is cmarkit's README source:

## Sample programs 

The [`cmarkit`] tool parses and renders CommonMark files in various
ways.

See also [`bench.ml`] and the [doc examples].

[`cmarkit`]: test/cmarkit_tool.ml
[`bench.ml`]: test/bench.ml
[doc examples]:  test/examples.ml

GitHub translates test.bench.ml into

https://github.com/dbuenzli/cmarkit/blob/main/test/bench.ml

To fix the broken link, we'd need to processing in ocaml.org to restore the complete link to GiutHub.

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

No branches or pull requests

3 participants