refactor: add order and section to language manual frontmatter #1116
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the ReScript documentation for migration to React Router by adding structured frontmatter metadata to all manual pages. The frontmatter includes section and order fields that will enable organization of the documentation through metadata instead of build scripts and configuration files.
- Adds
sectionfield to categorize pages into logical groups (Overview, Language Features, JavaScript Interop, Build System, Guides, Advanced Features) - Adds
orderfield to control page sequencing within each section - Maintains existing frontmatter structure while extending it with organizational metadata
Reviewed Changes
Copilot reviewed 62 out of 62 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| public/llms/manual/template.mdx | Template file updated with section "Overview" and order 4 |
| pages/docs/manual/v12.0.0/*.mdx | All 62 manual pages updated with appropriate section categorization and ordering |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Deploying rescript-lang-org with
|
| Latest commit: |
24c9fdc
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1f0beaa1.rescript-lang.pages.dev |
| Branch Preview URL: | https://vlk-add-order-and-section-to.rescript-lang.pages.dev |
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 87 out of 87 changed files in this pull request and generated no new comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
What if I don't use the order at all for a section? Will it be sorted alphabetically? |
That could be done pretty easily. I can tweak that, but this is a good starting point that reduces some of the file changes in the main PR. |
This is in preparation for the migration to React Router.
This doesn't do anything yet, but frontmatter will be the primary way to add details and organize markdown files instead of the build scripts and config files we use today.