Remove section about installing and using "tree" tool from get started tutorial #2909
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sabine
reviewed
Jan 7, 2025
data/tutorials/getting-started/1_02_your_first_ocaml_program.md
Outdated
Show resolved
Hide resolved
sabine
approved these changes
Jan 7, 2025
Collaborator
sabine
left a comment
sabine
left a comment
There was a problem hiding this comment.
@danielstocks Love this because, indeed, it's assuming people are on MacOS which is not necessarily the case, and we should be safely able to assume that people will know how to inspect directories in their OS of choice!
yawaramin
approved these changes
Jan 8, 2025
cuihtlauac
requested changes
Jan 8, 2025
Collaborator
cuihtlauac
left a comment
cuihtlauac
left a comment
There was a problem hiding this comment.
Thanks @danielstocks, this a nice improvement.
cuihtlauac
approved these changes
Jan 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello!
I recently ran through the get started and language guides on ocaml.org as a total beginner and they're very good, so thank you for that!
I have a small suggestion for an improvement: While going through Your First OCaml Program I felt that the Compiling OCaml Programs section goes on a bit of a unnecessary detour on installing
treeon MacOs with Homebrew, and was a bit hard to read due to all extra disclaimers (4) needed in case of issues with installing those toolsDon't get me wrong, I love
treeand I use it myself, but I simply suggest removing this section because I don't think it adds value to the core topic of the tutorial itself. There's nothing wrong with showing the directory structure created by dune init though, so I suggest keeping that, but only for illustrative purposes.In this PR you can se my suggested edits, please feel free to close this if you disagree!
Thanks again for all the great work!