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

Explicitely show broken reference in package documentation #1547

Closed
dbuenzli opened this issue Sep 28, 2023 · 4 comments · Fixed by #1564
Closed

Explicitely show broken reference in package documentation #1547

dbuenzli opened this issue Sep 28, 2023 · 4 comments · Fixed by #1564
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers outreachy Outreachy contributions and blog posts

Comments

@dbuenzli
Copy link

dbuenzli commented Sep 28, 2023

Note: this has been selected as an Outreachy issue. To be assigned, you must have completed the instructions in #1553.

Task

Currently, broken references in the package documentation are not easy to notice. We should add some CSS to highlight them.

Here's a page with such a broken reference ("a quick example").

What you need to do:

Add CSS to https://github.com/ocaml/ocaml.org/blob/main/asset/css/doc.css to style the broken references:

.xref-unresolved {
    ...
}

Broken reference should be styled to look like this:

Screenshot from 2023-10-03 10-31-47

@tmattio tmattio added the enhancement New feature or request label Sep 28, 2023
@sabine sabine added good first issue Good for newcomers outreachy Outreachy contributions and blog posts labels Oct 3, 2023
@oyenuga17
Copy link
Contributor

Hi @sabine Please I'm interested in working on this issue. I have read through the Outreachy Winter 2023 - 2024 doc, and I have successfully ran the hello-world project

@SaySayo
Copy link
Contributor

SaySayo commented Oct 3, 2023

Have you setup the project according to this guidelines depending on the outreachy project you're applying to? If you have, please send a screenshot.

@oyenuga17
Copy link
Contributor

Have you setup the project according to this guidelines depending on the outreachy project you're applying to? If you have, please send a screenshot.

Screenshot 2023-10-03 at 16 21 57 Screenshot 2023-10-03 at 16 22 17

@SaySayo

@SaySayo
Copy link
Contributor

SaySayo commented Oct 3, 2023

@oyenuga17 you will be assigned this issue, let me know if you need any pointers. cc @sabine

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers outreachy Outreachy contributions and blog posts
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants