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

Refer to both tutorials and API references as links #2088

Closed
cuihtlauac opened this issue Feb 22, 2024 · 8 comments · Fixed by #2146, #2153 or #2163
Closed

Refer to both tutorials and API references as links #2088

cuihtlauac opened this issue Feb 22, 2024 · 8 comments · Fixed by #2146, #2153 or #2163

Comments

@cuihtlauac
Copy link
Collaborator

cuihtlauac commented Feb 22, 2024

  1. Outside of code blocks, transform all references to standard manual modules, types and functions into links
  2. Sentences referring to tutorials matching an standard library module should also contain a direct link to the API reference

Examples:

In https://ocaml.org/docs/basic-data-types

Good, links:

Operations on `float` are provided by the [`Stdlib`](/api/Stdlib.html) and the [`Float`](/api/Float.html) modules.

Bad, no links:

The predefined function `fst` returns the first element of a pair, while `snd` returns the second element of a pair.
@priyakumari02
Copy link

@cuihtlauac Can I work on this issue?

@sabine
Copy link
Collaborator

sabine commented Mar 4, 2024

@priyakumari02 Totally, you can just go ahead and open a PR that mentions this issue. Then other people see someone is working on this. 👍 ✨

@maha-sachin
Copy link
Contributor

maha-sachin commented Mar 7, 2024

Hi @sabine, I am Maha from outreachy intern, May I know if this issue is assigned to anyone or is open?

@Dev-JoyA
Copy link

Dev-JoyA commented Mar 7, 2024

hi @sabine @SaySayo I am an outreachy intern, and i want to know if i can work on this issue, i am done with the ocaml set up.

@SaySayo
Copy link
Contributor

SaySayo commented Mar 8, 2024

Hi @maha-sachin, you can go ahead and open a pull request to this issue.

@MissJae
Copy link
Contributor

MissJae commented Mar 10, 2024

Hi, @SaySayo @sabine I'm Jennifer, an Outreachy applicant. So I was checking the links in the example given to better understand the task and realized that the links led to a 404 error. Is this supposed to happen? I'm very new to open-source contributions.
Ocaml Stdlib

@MissJae
Copy link
Contributor

MissJae commented Mar 10, 2024

Can I work on this? @SaySayo

@maha-sachin
Copy link
Contributor

https://ocaml.org/docs/basic-data-types

HI @SaySayo, Sure thing! I'll get right on it and open the pull request for this issue. Thanks for letting me know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
7 participants