Skip to content

Restructure docs #1010

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
May 4, 2025
Merged

Restructure docs #1010

merged 10 commits into from
May 4, 2025

Conversation

jderochervlk
Copy link
Collaborator

@jderochervlk jderochervlk commented May 3, 2025 •
edited
Loading

Miro board: https://miro.com/app/board/uXjVI63RQc0=/

  • Reorder the sidebar for the docs page to simplify categories and push advanced features to the bottom
  • Removes the dropdown nav when clicking on the docs link and goes directly to the docs page
  • Removes the JS library from the api sidebar and flatten the link structure
  • adds a link to the syntax search to the api sidebar, since the doc dropdown has been removed
  • adds a link to React in the top nav, to make it more prominent and since the doc dropdown has been removed

image

Docs sidebar top Docs sidebar bottom Api sidebar
image image image

@vercel Vercel
Copy link

vercel bot commented May 3, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
rescript-lang.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 4, 2025 3:41pm

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented May 3, 2025 •
edited
Loading

Deploying rescript-lang-org with  Cloudflare Pages  Cloudflare Pages

Latest commit: c2c3429
Status: ✅  Deploy successful!
Preview URL: https://43936a6b.rescript-lang.pages.dev
Branch Preview URL: https://vlk-v12-doc-restructure.rescript-lang.pages.dev

View logs

@jderochervlk jderochervlk force-pushed the vlk-v12-doc-restructure branch from bb7ab37 to b2ce083 Compare May 3, 2025 14:54
@jderochervlk jderochervlk marked this pull request as ready for review May 4, 2025 07:14
@jderochervlk jderochervlk marked this pull request as draft May 4, 2025 09:33
@jderochervlk jderochervlk force-pushed the vlk-v12-doc-restructure branch from a8f9e67 to a8a4ce8 Compare May 4, 2025 15:04
@jderochervlk jderochervlk marked this pull request as ready for review May 4, 2025 15:21
@jderochervlk jderochervlk marked this pull request as draft May 4, 2025 15:22
@jderochervlk jderochervlk marked this pull request as ready for review May 4, 2025 16:03
@fhammerschmidt fhammerschmidt merged commit 86255ff into master May 4, 2025
4 checks passed
@fhammerschmidt fhammerschmidt deleted the vlk-v12-doc-restructure branch May 4, 2025 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fhammerschmidt fhammerschmidt fhammerschmidt approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jderochervlk @fhammerschmidt