Skip to content

refactor: split out docs/manual routes from shared MdxRoute file#1221

Open
jderochervlk wants to merge 3 commits intomasterfrom
vlk/split-out-docs-manual
Open

refactor: split out docs/manual routes from shared MdxRoute file#1221
jderochervlk wants to merge 3 commits intomasterfrom
vlk/split-out-docs-manual

Conversation

@jderochervlk
Copy link
Copy Markdown
Collaborator

  • Add DocsManualRoute for /docs/manual pages with sidebar and TOC
  • Implement SidebarHelpers for sidebar nav/category generation
  • Add MdxFile.loadAllAttributes for loading manual doc frontmatter
  • Update routes to support manual docs and exclude from mdxRoutes
  • Document commit/PR conventions in AGENTS.md

@jderochervlk jderochervlk changed the title docs: add language manual route and sidebar helpers refactor: split out docs/manual routes from shared MdxRoute file Apr 3, 2026
Base automatically changed from vlk/split-out-blog-route to master April 3, 2026 21:25
@jderochervlk jderochervlk marked this pull request as ready for review April 5, 2026 15:50
@jderochervlk jderochervlk force-pushed the vlk/split-out-docs-manual branch from 1ae7265 to 05ae835 Compare April 5, 2026 15:56
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Refactors routing so /docs/manual/* pages are served by a dedicated DocsManualRoute (with sidebar + TOC), and introduces shared helpers/utilities to support manual doc navigation.

Changes:

  • Add DocsManualRoute to load/compile manual MDX, build sidebar categories, and generate a per-page table of contents.
  • Introduce SidebarHelpers and MdxFile.loadAllAttributes to generate sidebar nav data from MDX frontmatter.
  • Update route configuration to include manual docs routes and exclude them from the shared mdxRoutes; document PR/commit conventions in AGENTS.md.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/SidebarHelpers.resi Exposes sidebar helper function signatures for nav/category construction.
src/SidebarHelpers.res Implements sidebar nav item conversion and grouped category helpers.
src/MdxFile.resi Adds public API for loadAllAttributes to scan MDX frontmatter.
src/MdxFile.res Implements loadAllAttributes and refactors resolveFilePath formatting.
app/routes/DocsManualRoute.resi Declares loader data contract for manual docs route.
app/routes/DocsManualRoute.res New manual-docs route: compiles MDX, builds sidebar + TOC, renders layout.
app/routes.res Registers manual-docs routes and filters them out of mdxRoutes.
AGENTS.md Adds guidance for commit/PR conventions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 5, 2026

Cloudflare deployment

Deployement ID: 68138fe6-71dd-48b9-8778-6252eb25f239
Deployment Environment: preview

⛅️ wrangler 4.63.0 (update available 4.80.0)
─────────────────────────────────────────────
✨ Compiled Worker successfully
Uploading... (7211/7658)
Uploading... (7360/7658)
Uploading... (7509/7658)
Uploading... (7658/7658)
✨ Success! Uploaded 447 files (7211 already uploaded) (4.00 sec)

✨ Uploading _redirects
✨ Uploading Functions bundle
🌎 Deploying...
✨ Deployment complete! Take a peek over at https://68138fe6.rescript-lang.pages.dev
✨ Deployment alias URL: https://vlk-split-out-docs-manual.rescript-lang.pages.dev

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