[codex] Add docs guides section#1298
Merged
Merged
Conversation
Adds a new /docs/guides/overview section, wires it into the docs route map and secondary navigation, and covers the new nav item in Vitest and Cypress navigation tests.
jderochervlk
force-pushed
the
docs-guides-section
branch
from
91d7335 to
f90811f
Compare
Move the existing docs/guidelines package publishing page into the guides section, wire it into the guides sidebar, and add a permanent redirect from the old URL.
Wait for the live Headless UI gallery transition before cloning the landing page section for visual snapshots, avoiding a transient hidden image state in CI.
fhammerschmidt
approved these changes
May 9, 2026
jderochervlk
force-pushed
the
docs-guides-section
branch
from
390c6f3 to
0fc0440
Compare
Cloudflare deploymentDeployement ID: 15bce2b9-b2e9-44a1-8d21-d2fecc079bf8 ⛅️ wrangler 4.85.0 ✨ Uploading _redirects |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This adds in a new section where we can add more detailed guides.
Context
This adds the initial top-level Guides section to the documentation nav without moving existing guide-like pages yet. The new section gives us a stable route and overview page before we decide which existing docs should move and how redirects/canonicals should be handled.
Changes
/docs/guides/overviewbacked bymarkdown-pages/docs/guides/overview.mdx.DocsGuidesRoute.res/.resiusing the existing docs MDX layout/sidebar pattern.DocsRoutesand added the typed path entry.Guidesto the secondary docs navbar betweenAPIandSyntax Lookup.Follow-up Candidates
Existing guide-like pages that should be considered for a later move into
markdown-pages/docs/guides:docs/manual/rescript-for-javascript-developers.mdxdocs/manual/converting-from-js.mdxdocs/manual/project-structure.mdxdocs/manual/editor-code-analysis.mdxdocs/react/beyond-jsx.mdx,docs/react/extensions-of-props.mdx,docs/react/forwarding-refs.mdxThose moves are intentionally left out of this draft because they need canonical URL and redirect decisions.
Validation
Pre-PR/rebased branch checks:
git diff --check --cachedyarn build:resyarn workspace @rescript-lang/docs vitest:visual __tests__/visual/NavbarSecondary_.test.jsx --run --browser.headlessAdditional validation from the implementation pass before opening the PR:
yarn workspace @rescript-lang/docs formatyarn workspace @rescript-lang/docs testyarn workspace @rescript-lang/docs cypress run --spec e2e/Navigation.cy.jsx --browser electronyarn workspace @rescript-lang/docs build:viteNote: Cypress Chrome was unavailable in this environment, so the focused Cypress spec was run with Electron.