Skip to content

Conversation

PizieDust
Copy link
Contributor

This PR introduces a new way to onboard users into the OCaml ecosystem.
It uses a short interactive tutorial to guide the user through the various steps of setting up OCaml.

  • Installing Opam
  • Initializing Opam
  • Activating an Opam switch
  • Installing developer tools (ocaml lsp server, ocamlformat, odoc, utop, dune)
  • Verifying that ocaml is correctly setup with utop.
  • Finishing and linking to the tutorials for beginners on ocaml.org

cc @voodoos

@voodoos
Copy link
Collaborator

voodoos commented Mar 11, 2025

We should add the survey link in the onboarding. Maybe also in the status bar / command panel in a separate PR ?

@PizieDust PizieDust marked this pull request as ready for review March 11, 2025 11:26
@smorimoto smorimoto added type: feature New feature or request type: improvement labels Mar 13, 2025
@smorimoto smorimoto requested a review from voodoos March 13, 2025 10:47
@smorimoto smorimoto changed the title Ocaml Onboarding OCaml Onboarding Mar 13, 2025
@smorimoto
Copy link
Collaborator

It may be better to write the alt text more properly, or to leave it blank at all. We can come up with some ideas about that for accessibility.

@voodoos
Copy link
Collaborator

voodoos commented Mar 21, 2025

Is there a way to automatically check the various steps at the end of command execution ?
Ideally we would also not permit users to "install opam" if they already have opam installed...

@PizieDust
Copy link
Contributor Author

Is there a way to automatically check the various steps at the end of command execution ? Ideally we would also not permit users to "install opam" if they already have opam installed...

Indeed. I think the best way is to check if opam is installed and just move to the next step or exit the onboarding with a toast explaining opam is already installed

@PizieDust
Copy link
Contributor Author

Is there a way to automatically check the various steps at the end of command execution ?

Yes, this is now available.

@pitag-ha
Copy link
Member

Hi @PizieDust , this looks awesome! It could significantly improve the experience of people setting up OCaml. Would it be easy to drop a quick screencast of the walkthrough here? I'll review the code next week!

Copy link
Member

@pitag-ha pitag-ha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think we should merge this rather sooner than later and see what feedback we get.

Is the following comment from above already adressed?

Ideally we would also not permit users to "install opam" if they already have opam installed...

@PizieDust
Copy link
Contributor Author

@smorimoto Have you been able to try this out? I'm curious to get your observations

@PizieDust PizieDust changed the title OCaml Onboarding Opam Onboarding Sep 1, 2025
Copy link
Member

@pitag-ha pitag-ha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@smorimoto , what do you think? IMO if there's no reason why not to merge this, we should merge it to get some feedback :)

@smorimoto smorimoto linked an issue Sep 10, 2025 that may be closed by this pull request
PizieDust and others added 6 commits September 11, 2025 09:30
@PizieDust
Copy link
Contributor Author

@smorimoto Hi Sora. The merge conflicts are fixed now

@pitag-ha
Copy link
Member

Hi @smorimoto ,

I was wondering: Is there anything we haven't noticed that is blocking this from getting merged?

@smorimoto
Copy link
Collaborator

I don't think so, but basically I'm not in a position to decide when we add a new feature though.

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

Successfully merging this pull request may close these issues.

Add a Welcome page
4 participants