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

Tutorials Grouped By Section + Best Practices Broken Up #1429

Merged
merged 3 commits into from Jul 20, 2023

Conversation

sabine
Copy link
Collaborator

@sabine sabine commented Jul 20, 2023

This patch does two things:

  1. Group tutorials by section ("Get Started", "Language", "Platform Tools", "Guides") so they can show up under the respective tab
  2. Break up the "Best Practices" page into several "Platform Tools" tutorials.

As part of (1), we remove the HTMX navigation from the Learn area, since the sidebars do not scroll enough to warrant the complexity now.

This brings the Learn Homepage into a state where a layout according to Figma and the documentation rework can be implemented.

The tabs, for now, lead to the first tutorial in that section, except for the Platform/Exercises/Books pages, which have their own dedicated page.

page screenshot
Learn Homepage Screenshot 2023-07-20 at 12-56-24 Learn OCaml
Get Started Screenshot 2023-07-20 at 12-48-41 Get Up and Running With OCaml · OCaml Tutorials
Language Screenshot 2023-07-20 at 12-48-45 Data Types and Matching · OCaml Tutorials
Platform Tools Screenshot 2023-07-20 at 12-48-53 OCaml Platform
Guides Screenshot 2023-07-20 at 12-48-49 Formatting and Wrapping Text · OCaml Tutorials

Copy link
Collaborator

@tmattio tmattio left a comment

Choose a reason for hiding this comment

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

Thanks @sabine, that looks very good! I do have comments on the overall organisation, but since the documentation outline is still in progress, I don't think it's helpful to discuss this as part of this PR.
The only thing I feel semi-strongly about is the PPX guide under the Platform tool. Ppxlib is a platform tool, but PPX is a language concept. The guide would be better placed under language in my opinion.
This shouldn't block the merge, so I'm approving nonetheless and leaving it to you to decide what's best.

@sabine
Copy link
Collaborator Author

sabine commented Jul 20, 2023

I'll move the PPX guide to language.

Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
@sabine sabine merged commit dff235a into ocaml:main Jul 20, 2023
2 of 3 checks passed
@sabine sabine deleted the tutorials_by_learn_area_section branch July 20, 2023 13:37
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.

None yet

3 participants