Skip to content

Website Tutorial: add full, scrollable table of contents. #7778

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

Closed
wants to merge 1 commit into from

Conversation

benjamindblock
Copy link

Overview

A few updates to make the Tutorial section of the website easier to navigate. I believe this will help new Roc developers by showing off the full contents of the Tutorial quickly and easily. It will also help current devs by making the documentation easier to navigate. I took some inspiration from the Odin lang overview page.

Changes:

  • Adds the full contents of the tutorial to the Table of Contents (TOC)
  • Makes the TOC scrollable to accommodate all of the content
  • Makes the TOC fixed on the right hand side in desktop view
  • Adjusts some font sizes to fit more content onto the page

I kept the mobile TOC as it is now.

Desktop

Screenshot 2025-05-10 at 11 36 59 AM

Mobile

Screenshot 2025-05-10 at 5 09 35 PM

In mobile view, use only the top-level list elements so that we can keep
the current styling.
@Anton-4
Copy link
Collaborator

Anton-4 commented May 12, 2025

Thanks for your contribution @benjamindblock!

I was wondering if we should re-use the (styling of the) sidebar from the docs here 🤔
Screenshot_20250512_163754

@Anton-4
Copy link
Collaborator

Anton-4 commented May 12, 2025

I was wondering if we should re-use the (styling of the) sidebar from the docs here 🤔

Before I get you started on this @benjamindblock, @rtfeldman what do you think in general about the detailed table of contents that this PR proposes?

@gamebox
Copy link
Collaborator

gamebox commented May 16, 2025

just for context @benjamindblock we are planning a more thorough rewrite AND redesign of the tutorial for v0.1

@benjamindblock
Copy link
Author

Thanks for the details @Anton-4 and @gamebox -- if it makes the most sense to hold off on any updates until v0.1 comes along with the full redesign, that makes sense to me. Let me know!

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.

3 participants