Skip to content

Move ocamlformat page under "Tooling" #2969

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bbatsov
Copy link
Contributor

@bbatsov bbatsov commented Feb 18, 2025

As mentioned in #2965, I think that's the right place for this page in the menu. The link's the same, so there's nothing else that needs changing.

Copy link
Collaborator

@cuihtlauac cuihtlauac left a comment

Choose a reason for hiding this comment

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

@bbatsov Why this change? I don't understand the motivation

@bbatsov
Copy link
Contributor Author

bbatsov commented Feb 20, 2025

Just to expand a bit on the reasoning - ocamlformat seems more related to the editor tooling than to the OCaml Platform (which I see as the compiler, standard library, opam and potentially dune).

In general I didn't see a clear definition of what's considered part of the Platform, so that's just my interpretation based on what's considered Platform in other programming communities.

@cuihtlauac
Copy link
Collaborator

Since #2968 moves “Configuring Your Editor” from “Platform” to “Get Started” it leaves the “Platform / Editor Support” section with only one item: “Formatting Your Code”. And this renames “Editor” into “Tooling”.

Please provide that kind of information when creating a PR, that helps review.

I agree “Editor Support” isn't a great section title. I don't think “Tooling” is an improvement, it remains vague. That doesn't help indexing by search and LLM engines.

For the sake of consistency, I'd rather stick with old name, it's not great, but we prefer to change only if an issue is genuinely fixed.

@bbatsov
Copy link
Contributor Author

bbatsov commented Feb 20, 2025

I agree “Editor Support” isn't a great section title. I don't think “Tooling” is an improvement, it remains vague. That doesn't help indexing by search and LLM engines.

The rename is only to group this together with the other similar articles (it's not a preferences for "Tooling" over "Editor Support"). I think this will improve the discoverability of this section a lot. If we keep the name of this section it will stay apart from the other related articles.

@cuihtlauac
Copy link
Collaborator

I've merged PR #2965. Can you rebase this PR? I must admit I'm still missing the point of this one.

@bbatsov
Copy link
Contributor Author

bbatsov commented Feb 21, 2025

Most to consolidate the editor-related docs in the same section. Now we have this page shown on Learn -> Platform -> Editor Support and I think it's better to be shown on Learn -> Getting Started -> Tooling. Alternative I can suggest folding the single-item sections on the Platform page under Projects:

image

The odoc and ocamlformat pages make sense in this context. Overall my point is that high-level sections and their subsections are not organized in the most logical way and I've been trying to improve this a bit.

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

Successfully merging this pull request may close these issues.

2 participants