docs: Migrate docs from Docusaurus to Mintlify #375
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughAdds YAML front matter and normalizes EOF/code-fence formatting across many MDX docs; adds new guide pages and a Mintlify docs configuration; removes several Docusaurus category files and legacy website docs and cleans website .gitignore/README entries. Changes
Sequence Diagram(s)Not applicable for documentation/metadata-only changes. Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
docs/widgets/custom_scroll_view.mdx (1)
29-52: Fix invalid JSON syntax in the example.The JSON example has a trailing comma after
"backgroundColor": "primary",on line 49. JSON objects must not have a trailing comma after the last property—this will cause JSON parsing errors if someone copies this example.Apply this diff to fix the JSON syntax:
"backgroundColor": "primary" }Ensure the comma is removed from line 49.
docs/widgets/sliver_app_bar.mdx (1)
26-26: Minor: Duplicate property entry in table.The property
titleSpacingappears twice in the properties table (lines 26 and 38) with slightly different descriptions. Consider consolidating these entries or clarifying if they represent different concepts.Also applies to: 38-38
docs/widgets/switch.mdx (2)
31-31: Fix typo in property description.Line 31 contains a double-letter typo: "TThe" should be "The".
Apply this diff to fix the typo:
-| trackColor | `StacMaterialColor` | TThe color of this Switch's track. | +| trackColor | `StacMaterialColor` | The color of this Switch's track. |
22-22: Minor grammar issue in property description.Line 22 uses incorrect possessive form: "for the button's when a pointer" should be "for the button when a pointer".
Apply this diff to fix the grammar:
-| hoverColor | `String` | The color for the button's when a pointer is hovering over it. | +| hoverColor | `String` | The color for the button when a pointer is hovering over it. |docs/widgets/wrap.mdx (1)
28-100: Fix JSON syntax error: trailing comma in array.The JSON example contains a trailing comma after the last object in the children array (line 98), which is invalid JSON syntax. This will cause parsing errors for any developer copying this example.
Apply this diff to remove the trailing comma:
{ "type": "container", "color": "#D1C4E9", "width": 100, "height": 100, "child": { "type": "center", "child": { "type": "text", "data": "4", "style": { "color": "#FFFFFF" } } } - }, + } ] }docs/widgets/spacer.mdx (1)
14-14: Critical: Table separator contains corrupted text.Line 14 contains
--chore-----instead of regular dashes. This breaks the markdown table formatting and will render incorrectly in Mintlify.Apply this diff to fix the table separator:
-| flex | `int` | The flex factor to use for the spacer. Defaults to `1`. | -|----------|--chore-----|---------------------------------------------------------| +| Property | Type | Description | +|----------|-------|---------------------------------------------------------| | flex | `int` | The flex factor to use for the spacer. Defaults to `1`. |Alternatively, verify the correct table structure matches the original Docusaurus version.
🧹 Nitpick comments (18)
docs/widgets/flexible.mdx (1)
2-3: Consider enhancing the description for better discoverability.The current description ("Documentation for Flexible") is generic. For a documentation migration to Mintlify, more descriptive text would improve SEO and search indexability. Consider something like: "Learn how to build a Flutter Flexible widget using JSON with Stac" or "Build responsive Flutter layouts with the Stac Flexible widget."
Apply this diff to make the description more informative:
--- title: "Flexible" -description: "Documentation for Flexible" +description: "Build responsive Flutter layouts with the Stac Flexible widget using JSON configuration" ---docs/widgets/limited_box.mdx (1)
3-3: Consider enhancing the description for better discoverability.The description is currently generic. For Mintlify documentation, a more descriptive phrase helps with SEO and user scanning. Consider something like: "Learn how to build Flutter LimitedBox widgets using JSON with configurable height and width constraints."
docs/widgets/table_row.mdx (1)
1-4: Consider a more descriptive front matter description (optional).The description "Documentation for TableRow" is generic. For better SEO and user experience in Mintlify, consider something more specific, e.g., "Learn how to define Flutter TableRow widgets using JSON with STAC."
docs/widgets/text_form_field.mdx (1)
3-3: Consider enhancing description specificity.The description "Documentation for TextFormField" is generic. For a large-scale migration, consider adding descriptions that highlight key features or use cases (e.g., "Build Flutter TextFormField widgets using JSON with validation and input formatting"). This improves SEO and discoverability in the documentation.
docs/widgets/scaffold.mdx (1)
1-84: Consider a more descriptive front matter description.The description field ("Documentation for Scaffold") is generic. While this may be intentional for consistency across the 80+ migrated docs, a slightly more specific description would improve discoverability. For example: "Learn how to build a Flutter scaffold widget using JSON with Stac" or similar.
This is optional and can be addressed now or as part of a follow-up documentation polish pass.
docs/widgets/tab_bar.mdx (1)
1-5: YAML front matter format looks good.The Mintlify-style front matter is correctly structured with proper delimiters and fields. The title appropriately matches the main heading.
As an optional improvement, consider making the description more specific to help with documentation discovery. For example:
"Build Flutter TabBar and DefaultTabController widgets from JSON with comprehensive property documentation and examples."This would be more informative than the generic description and help users understand what's in this page before clicking.docs/widgets/positioned.mdx (1)
1-4: YAML front matter added for Mintlify migration—consider more descriptive metadata.The YAML front matter is syntactically correct and properly formatted. However, the description
"Documentation for Positioned"is quite generic. For better discoverability and SEO, consider using a more descriptive summary that explains the widget's purpose.--- title: "Positioned" - description: "Documentation for Positioned" + description: "Build a Flutter Positioned widget using JSON to place child widgets at specific coordinates within a parent widget" ---Note: If this description template is standardized across all 80+ files being migrated, feel free to disregard this suggestion as a consistency trade-off.
docs/widgets/fitted_box.mdx (1)
1-4: Enhance the description for better SEO and user context.The description "Documentation for FittedBox" is generic and doesn't convey the specific value or purpose of the FittedBox widget to users searching for documentation. Consider a more descriptive alternative that summarizes what users will learn, such as:
description: "Learn how to configure the Flutter FittedBox widget to scale and position child widgets within constrained boxes using Stac JSON."This approach improves SEO and sets clearer expectations for documentation discovery in the Mintlify interface.
docs/widgets/fractionally_sized_box.mdx (1)
1-37: Consider enhancing description metadata for better SEO and discoverability.The current description is generic. For Mintlify, more specific descriptions can improve documentation discoverability and SEO. Example:
"Learn how to build a Flutter fractionally sized box widget using JSON in Stac."Additionally, check whether your Mintlify configuration defines other metadata fields (e.g.,icon,group,category) that should be included.If additional metadata fields are required or recommended by your Mintlify setup, please verify against your
mint.jsonconfiguration file.docs/concepts/theming.mdx (1)
2-3: Consider a more descriptive summary (optional improvement).The description
"Documentation for Theming"is generic. For better discoverability and SEO, consider a more specific summary, such as:"Learn how to implement dynamic theming in Stac using JSON to manage your application's visual style"This is a nice-to-have refinement for the bulk migration.
docs/widgets/backdrop_filter.mdx (1)
1-4: Consider a more descriptive front matter description.The current description ("Documentation for BackdropFilter") is generic. For better user experience in Mintlify's documentation portal, consider a more specific description that conveys the widget's purpose. For example: "Learn how to use the BackdropFilter widget to apply image filters and create visual effects in Flutter layouts."
docs/widgets/slider.mdx (1)
1-62: Consider more descriptive front matter across the migration.The description "Documentation for Slider" is functional but generic. For improved discoverability and clarity, consider using more specific descriptions that capture the key purpose or functionality, e.g., "Learn how to build Flutter Slider widgets using JSON in Stac." This is a minor refinement and can be applied consistently across all migrated files if desired.
docs/widgets/gesture_detector.mdx (1)
1-4: Consider a more descriptive title and description for Mintlify metadata.The YAML front matter is syntactically correct, but the description is generic. Mintlify may use these fields for search indexing and site navigation, so a more descriptive summary would improve discoverability. For example: "Documentation for GestureDetector" could be "Detect gestures and user interactions with the GestureDetector widget."
Apply this diff to enhance the metadata:
--- title: "GestureDetector" -description: "Documentation for GestureDetector" +description: "Detect gestures and user interactions such as taps, drags, long presses, and force presses using the GestureDetector widget" ---docs/styles/border_side.mdx (1)
1-4: Consider more descriptive front matter for SEO and navigation.The description field appears under the title on the page and as the meta description for SEO. The current generic text ("Documentation for Border Side") doesn't provide meaningful context. Consider updating descriptions across all 80+ migrated files to briefly summarize the content—e.g., "Configure borders with individual control for each side (top, right, bottom, left)" for this file.
This can improve both discoverability and AI ingestion for the documentation platform.
docs/styles/box_fit.mdx (1)
1-4: Standardize title casing to match other docs.The title is "BoxFit" (camelCase), but other multi-word docs use Title Case with spaces (e.g., "Border Side," "Border Radius"). Consider updating to "Box Fit" for consistency. This pattern likely applies across the 80+ migrated files and should be reviewed globally.
docs/widgets/list_tile.mdx (1)
136-137: Minor: Extra blank line at EOF.Line 137 contains an extra blank line after the code fence. For consistency with other migrated files, consider removing this trailing blank line or verify if this aligns with the Mintlify/project formatting standard.
docs/widgets/placeholder.mdx (1)
1-5: Front matter structure looks good—consider enriching descriptions.The YAML front matter is syntactically correct and follows a consistent pattern. However, descriptions across the widget docs use a generic
"Documentation for X"template that doesn't add much value to the front matter. Consider making them more descriptive (e.g., "A Flutter placeholder widget for marking incomplete UI areas in Stac JSON").docs/widgets/icon.mdx (1)
1-5: Clean migration following established pattern.The front matter and structure align with the placeholder.mdx update. Same opportunity here to enhance the description beyond the generic template.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (11)
docs/assets/banner.pngis excluded by!**/*.pngdocs/assets/console.pngis excluded by!**/*.pngdocs/assets/hello_world.pngis excluded by!**/*.pngdocs/favicon.icois excluded by!**/*.icodocs/logo.svgis excluded by!**/*.svgdocs/logo/dark.svgis excluded by!**/*.svgdocs/logo/light.svgis excluded by!**/*.svgwebsite/package-lock.jsonis excluded by!**/package-lock.jsonwebsite/static/img/form_screen_image.pngis excluded by!**/*.pngwebsite/static/img/logo.pngis excluded by!**/*.pngwebsite/static/img/stac_banner.pngis excluded by!**/*.png
📒 Files selected for processing (107)
docs/actions/delay_action.mdx(2 hunks)docs/actions/dialog.mdx(2 hunks)docs/actions/form_validate.mdx(2 hunks)docs/actions/get_form_value.mdx(2 hunks)docs/actions/modal_bottom_sheet.mdx(2 hunks)docs/actions/multi_action.mdx(2 hunks)docs/actions/navigate.mdx(2 hunks)docs/actions/network_request.mdx(2 hunks)docs/actions/none.mdx(2 hunks)docs/actions/snack_bar.mdx(2 hunks)docs/cli.mdx(1 hunks)docs/concepts/action_parsers.mdx(2 hunks)docs/concepts/parsers.mdx(2 hunks)docs/concepts/theming.mdx(2 hunks)docs/docs.json(1 hunks)docs/get_started.mdx(1 hunks)docs/introduction.mdx(1 hunks)docs/project_structure.mdx(1 hunks)docs/quickstart.mdx(1 hunks)docs/styles/border.mdx(2 hunks)docs/styles/border_radius.mdx(2 hunks)docs/styles/border_side.mdx(2 hunks)docs/styles/box_fit.mdx(2 hunks)docs/styles/clip_behavior.mdx(2 hunks)docs/styles/colors.mdx(2 hunks)docs/styles/stac_alignment_directional.mdx(2 hunks)docs/styles/table_border.mdx(2 hunks)docs/styles/table_column_width.mdx(2 hunks)docs/widgets/alert_dialog.mdx(2 hunks)docs/widgets/align.mdx(2 hunks)docs/widgets/app_bar.mdx(2 hunks)docs/widgets/aspect_ratio.mdx(2 hunks)docs/widgets/auto_complete.mdx(2 hunks)docs/widgets/backdrop_filter.mdx(2 hunks)docs/widgets/bottom_navigation_bar.mdx(2 hunks)docs/widgets/card.mdx(2 hunks)docs/widgets/carousel_view.mdx(2 hunks)docs/widgets/center.mdx(2 hunks)docs/widgets/check_box.mdx(2 hunks)docs/widgets/chip.mdx(2 hunks)docs/widgets/circle_avatar.mdx(2 hunks)docs/widgets/circular_progress_indicator.mdx(2 hunks)docs/widgets/clip_oval.mdx(2 hunks)docs/widgets/clip_rrect.mdx(2 hunks)docs/widgets/colored_box.mdx(2 hunks)docs/widgets/column.mdx(2 hunks)docs/widgets/container.mdx(2 hunks)docs/widgets/custom_scroll_view.mdx(2 hunks)docs/widgets/drawer.mdx(2 hunks)docs/widgets/dropdown_menu.mdx(2 hunks)docs/widgets/dynamic_view.mdx(2 hunks)docs/widgets/elevated_button.mdx(2 hunks)docs/widgets/expanded.mdx(2 hunks)docs/widgets/filled_button.mdx(2 hunks)docs/widgets/fitted_box.mdx(2 hunks)docs/widgets/flexible.mdx(2 hunks)docs/widgets/floating_action_button.mdx(2 hunks)docs/widgets/form.mdx(2 hunks)docs/widgets/fractionally_sized_box.mdx(2 hunks)docs/widgets/gesture_detector.mdx(2 hunks)docs/widgets/grid_view.mdx(2 hunks)docs/widgets/icon.mdx(2 hunks)docs/widgets/icon_button.mdx(2 hunks)docs/widgets/image.mdx(2 hunks)docs/widgets/ink_well.mdx(2 hunks)docs/widgets/limited_box.mdx(2 hunks)docs/widgets/linear_progress_indicator.mdx(2 hunks)docs/widgets/list_tile.mdx(2 hunks)docs/widgets/listview.mdx(2 hunks)docs/widgets/network_widget.mdx(2 hunks)docs/widgets/opacity.mdx(2 hunks)docs/widgets/outlined_button.mdx(2 hunks)docs/widgets/padding.mdx(2 hunks)docs/widgets/page_view.mdx(2 hunks)docs/widgets/placeholder.mdx(2 hunks)docs/widgets/positioned.mdx(2 hunks)docs/widgets/radio_group.mdx(2 hunks)docs/widgets/refresh_indicator.mdx(2 hunks)docs/widgets/row.mdx(2 hunks)docs/widgets/safe_area.mdx(2 hunks)docs/widgets/scaffold.mdx(2 hunks)docs/widgets/single_child_scroll_view.mdx(2 hunks)docs/widgets/sized_box.mdx(2 hunks)docs/widgets/slider.mdx(2 hunks)docs/widgets/sliver_app_bar.mdx(2 hunks)docs/widgets/spacer.mdx(2 hunks)docs/widgets/stack.mdx(2 hunks)docs/widgets/switch.mdx(2 hunks)docs/widgets/tab_bar.mdx(2 hunks)docs/widgets/table.mdx(2 hunks)docs/widgets/table_cell.mdx(2 hunks)docs/widgets/table_row.mdx(2 hunks)docs/widgets/text.mdx(2 hunks)docs/widgets/text_button.mdx(2 hunks)docs/widgets/text_field.mdx(2 hunks)docs/widgets/text_form_field.mdx(2 hunks)docs/widgets/vertical_divider.mdx(2 hunks)docs/widgets/visibility.mdx(2 hunks)docs/widgets/webview.mdx(2 hunks)docs/widgets/wrap.mdx(2 hunks)website/.gitignore(0 hunks)website/README.md(0 hunks)website/docs/actions/_category_.json(0 hunks)website/docs/concepts/_category_.json(0 hunks)website/docs/intro.md(0 hunks)website/docs/styles/_category_.json(0 hunks)website/docs/why_stac.md(0 hunks)
⛔ Files not processed due to max files limit (8)
- website/docs/widgets/category.json
- website/docusaurus.config.ts
- website/package.json
- website/sidebars.ts
- website/src/css/custom.css
- website/theme/darkTheme.ts
- website/theme/lightTheme.ts
- website/tsconfig.json
💤 Files with no reviewable changes (7)
- website/README.md
- website/docs/actions/category.json
- website/docs/why_stac.md
- website/docs/concepts/category.json
- website/docs/intro.md
- website/docs/styles/category.json
- website/.gitignore
🧰 Additional context used
🪛 LanguageTool
docs/introduction.mdx
[grammar] ~11-~11: Ensure spelling is correct
Context: ...get in Flutter, you define your UI as Stac Widgets that render at runtime from J...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/quickstart.mdx
[grammar] ~181-~181: Ensure spelling is correct
Context: ...const MyApp()); } ``` Now that stac is initalize our app is ready to be dynamic and serv...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~181-~181: Use a hyphen to join words.
Context: ...ur app is ready to be dynamic and server driven. We can now render our `hello_wo...
(QB_NEW_EN_HYPHEN)
docs/project_structure.mdx
[style] ~6-~6: ‘overall structure’ might be wordy. Consider a shorter alternative.
Context: ...organized" --- This guide explains the overall structure of a Stac project. It covers where the ...
(EN_WORDINESS_PREMIUM_OVERALL_STRUCTURE)
🔇 Additional comments (93)
docs/widgets/expanded.mdx (2)
1-4: YAML front matter properly formatted.The metadata is well-structured and consistent with Mintlify conventions. Title matches the heading, and the description is clear and appropriate.
29-29: Trailing newline formatting is consistent.The addition of a trailing newline after the code block improves consistency across the documentation files and aligns with standard markdown practices.
docs/widgets/flexible.mdx (2)
1-4: Front matter is correctly formatted.The YAML front matter is syntactically valid and properly structured for Mintlify. The metadata is present and well-formed.
6-31: Content preserved correctly with proper formatting.The main documentation content is intact, and the trailing newline after the closing code fence (line 31) follows standard markdown practices. No functional issues detected.
docs/widgets/linear_progress_indicator.mdx (2)
1-4: YAML front matter added correctly for Mintlify.The front matter is properly formatted with title and description metadata. Content remains fully intact below the front matter separator.
5-5: Good spacing and formatting hygiene.Blank line after front matter and trailing newline at end-of-file follow markdown best practices.
Also applies to: 41-41
docs/widgets/clip_oval.mdx (2)
1-4: YAML front matter added for Mintlify migration.The front matter is properly formatted with title and description metadata. Ensure the description meets Mintlify's content requirements—verify this is consistent with how descriptions are structured across other migrated widget documentation files in the PR (e.g., for SEO/preview purposes).
33-33: Trailing newline normalization is appropriate.Adding a trailing newline after the closing code fence aligns with Markdown best practices and consistency across the documentation.
docs/widgets/vertical_divider.mdx (1)
1-4: YAML front matter addition looks good.The Mintlify metadata is correctly formatted and follows the expected structure for documentation migration. The
titleanddescriptionfields are properly set.docs/widgets/opacity.mdx (1)
1-5: LGTM! Front matter added correctly for Mintlify migration.The YAML front matter is properly formatted with valid syntax, and the title and description are appropriate. All existing documentation content has been preserved without alterations. The file follows Mintlify conventions for MDX documentation.
docs/widgets/single_child_scroll_view.mdx (1)
1-53: Clean migration to Mintlify documentation format.The YAML front matter is correctly formatted with appropriate title and description metadata. The documentation content is fully preserved, and formatting (spacing, code fence, trailing newline) aligns with Mintlify standards. No structural or syntax issues detected.
docs/widgets/custom_scroll_view.mdx (1)
1-5: YAML front matter formatting looks good.The title and description are properly formatted for Mintlify migration.
docs/widgets/limited_box.mdx (1)
1-4: YAML front matter correctly added for Mintlify.The metadata structure is properly formatted and follows Mintlify conventions.
docs/widgets/table_cell.mdx (1)
1-5: Mintlify front matter and formatting look good.The YAML front matter is correctly formatted and properly separated from the content. The trailing newline at the end of the file aligns with best practices and the broader migration pattern.
Also applies to: 35-35
docs/widgets/elevated_button.mdx (2)
1-4: YAML front matter structure is correct for Mintlify.The YAML front matter has proper syntax and delimiters. The title and description are appropriate for documentation indexing.
6-44: Documentation content and formatting are well-structured.The markdown structure is clear, the Properties table is properly formatted, the JSON example is syntactically correct, and the code block has proper language annotation and closing delimiters. The trailing newline after the closing fence is appropriate for file formatting standards.
docs/widgets/table_row.mdx (1)
1-5: YAML front matter properly added for Mintlify migration.The YAML front matter is correctly formatted with appropriate title and description fields. The blank line separator after the front matter (line 5) is properly positioned.
docs/widgets/stack.mdx (1)
1-43: LGTM! Documentation metadata properly structured for Mintlify migration.The YAML frontmatter is correctly formatted with appropriate title and description metadata. The blank line separation (line 5) and code block formatting are aligned with Mintlify conventions. Content is fully preserved with no regressions.
docs/widgets/sliver_app_bar.mdx (1)
1-4: YAML front matter properly formatted for Mintlify.The metadata addition follows standard Mintlify conventions and integrates cleanly with the existing documentation content.
docs/widgets/text_form_field.mdx (1)
1-4: YAML front matter correctly formatted for Mintlify.The YAML metadata follows the expected structure and is properly formatted. The title aligns with the markdown heading below.
docs/widgets/icon_button.mdx (1)
1-5: LGTM—YAML front matter correctly structured for Mintlify.The addition of YAML front matter with title and description follows the standard Mintlify documentation format. The blank line separator (line 5) ensures proper parsing of front matter.
docs/widgets/circle_avatar.mdx (2)
1-5: YAML front matter properly added for Mintlify compatibility.The addition of YAML front matter with title and description is correctly formatted and aligns with the PR's migration from Docusaurus to Mintlify. The title matches the document heading, and the blank line separation (line 5) follows Markdown conventions.
6-40: Documentation content integrity preserved.The existing CircleAvatar widget documentation—overview, properties table, and example JSON—remains intact and well-structured. No functional or content changes were made during the migration.
docs/widgets/carousel_view.mdx (2)
1-4: Well-structured YAML front matter for Mintlify migration.The front matter correctly adds the
titleanddescriptionmetadata required by Mintlify, following standard conventions. The content heading (line 6) aligns with the front matter title.
32-72: Code fence properly closed and formatting fixed.The JSON code block is complete and properly terminated. The trailing newline adjustment aligns with the file format expectations for the Mintlify documentation structure.
docs/widgets/bottom_navigation_bar.mdx (1)
1-5: Mintlify front matter correctly added.The YAML front matter is properly formatted with appropriate title and description metadata for the Mintlify documentation system. The empty line separation is correct.
docs/widgets/switch.mdx (1)
1-4: YAML frontmatter correctly added for Mintlify.The frontmatter structure is properly formatted and ready for Mintlify integration.
docs/widgets/wrap.mdx (1)
1-5: YAML front matter added correctly.The YAML front matter with title and description has been properly formatted with correct delimiters and spacing. The empty line (line 5) properly separates front matter from content.
docs/widgets/padding.mdx (1)
1-5: Frontmatter correctly formatted for Mintlify migration.The YAML frontmatter is valid, properly delimited, and includes the required title and description fields. The blank line following the closing
---is correctly placed. The existing documentation content below remains intact.docs/widgets/scaffold.mdx (1)
1-4: YAML front matter properly added for Mintlify.The front matter follows the Mintlify convention with proper formatting and delimiter placement.
docs/widgets/text_button.mdx (1)
1-5: LGTM!The YAML front matter is correctly formatted for Mintlify with proper delimiters and structure. The blank line after the front matter provides appropriate separation from the content, and the trailing newline is in place. The existing documentation content remains intact and well-structured.
docs/widgets/positioned.mdx (1)
1-96: Front matter and content structure look good for Mintlify.The YAML front matter has been properly added, the markdown content remains intact, and the file structure (properties table, multiple code examples) is well-organized. The file ends with a proper closing code fence.
docs/widgets/fitted_box.mdx (1)
1-41: YAML front matter structure looks good.The front matter is properly formatted with valid YAML syntax, the title matches the document heading, and the trailing blank line at EOF follows markdown best practices.
docs/widgets/fractionally_sized_box.mdx (1)
1-4: YAML front matter correctly formatted for Mintlify.The front matter structure is valid and will integrate properly with Mintlify. Title and description fields are present and appropriate.
docs/concepts/theming.mdx (1)
2-4: Front matter structure is correct for Mintlify.The YAML front matter properly follows Mintlify conventions with title and description fields. The removal of the explicit
# Themingheading in favor of the front matter title is the right approach for this documentation platform.docs/widgets/text.mdx (1)
1-4: Well-executed Mintlify migration for this file.The YAML front matter is properly formatted with a clear, accurate title and description. The trailing blank line addition aligns with standard markdown file hygiene. The existing content (table, example JSON) is preserved as-is without breaking changes, and no Docusaurus-specific syntax remains. The external Flutter API documentation link is intact.
Also applies to: 40-40
docs/widgets/backdrop_filter.mdx (2)
1-4: YAML front matter correctly added for Mintlify migration.The metadata is properly formatted with clear title and description tags. This aligns well with the PR's documentation migration objectives.
237-237: Formatting fix improves list consistency.Removing the extraneous leading dash normalizes the third bullet point to match the numbering convention of adjacent list items (1, 2, 3).
docs/widgets/slider.mdx (2)
1-4: YAML front matter properly formatted for Mintlify.The front matter is correctly structured with title and description fields. The file structure is consistent with the broader migration pattern across 80+ documentation files.
6-62: Document content and formatting look solid.The properties table is well-formatted, the example JSON is properly structured, and the trailing newline (line 62) is correctly added. No formatting or content issues detected.
docs/concepts/parsers.mdx (2)
2-3: Front matter migration to Mintlify format looks good.The transition from Docusaurus
sidebar_positionto Mintlifytitleanddescriptionis correct. The metadata fields are appropriate and well-formed.
6-137: Content migration complete and well-structured.The document content is fully preserved with proper formatting. All sections, code examples, and references remain intact through the Mintlify migration.
docs/concepts/action_parsers.mdx (2)
2-3: Front matter follows consistent Mintlify migration pattern.Title and description fields align with the same pattern observed in parsers.mdx, establishing a consistent metadata structure across concept documents.
6-109: Content migration is complete and maintains document structure.All sections, code examples, and formatting are preserved. The document translates cleanly to Mintlify format without content loss.
docs/styles/clip_behavior.mdx (1)
1-4: Verify title matches file semantics and sidebar needs.The title is shortened to "Clip" while the filename is
clip_behavior.mdx. Please confirm this title choice aligns with your navigation structure and user expectations. Other docs use fuller titles (e.g., "Border Side," "Border Radius"). If brevity is intentional for sidebar display, consider adding asidebarTitlefield to the front matter.docs/styles/stac_alignment_directional.mdx (1)
1-5: YAML front matter correctly formatted for Mintlify.The YAML front matter with title and description metadata is properly structured and follows Mintlify conventions.
docs/widgets/drawer.mdx (1)
1-4: YAML front matter added correctly for Mintlify.The metadata (title and description) follows the expected format for Mintlify documentation.
docs/widgets/floating_action_button.mdx (1)
1-4: YAML front matter added correctly for Mintlify.The metadata (title and description) follows the expected format for Mintlify documentation.
docs/widgets/center.mdx (1)
1-4: YAML front matter added correctly for Mintlify.The metadata (title and description) follows the expected format for Mintlify documentation.
docs/widgets/text_field.mdx (1)
1-4: YAML front matter added correctly for Mintlify.The metadata (title and description) follows the expected format for Mintlify documentation.
docs/widgets/alert_dialog.mdx (1)
1-4: YAML front matter added correctly for Mintlify.The metadata (title and description) follows the expected format for Mintlify documentation.
docs/widgets/table.mdx (1)
1-4: YAML front matter added correctly for Mintlify.The metadata (title and description) follows the expected format for Mintlify documentation.
docs/widgets/list_tile.mdx (1)
1-4: YAML front matter added correctly for Mintlify.The metadata (title and description) follows the expected format for Mintlify documentation.
docs/widgets/app_bar.mdx (1)
1-5: YAML front matter addition looks good.The metadata structure is syntactically correct and follows Mintlify conventions. Front matter is properly delimited and descriptions are consistent across the migration.
docs/widgets/sized_box.mdx (1)
1-5: Metadata and formatting consistent with other widget docs.Front matter follows Mintlify conventions; trailing newline properly added.
Also applies to: 26-26
docs/widgets/radio_group.mdx (1)
1-5: Front matter and formatting standardized.Changes align with migration pattern observed across all widget documentation files.
docs/widgets/auto_complete.mdx (1)
1-5: Front matter properly added and formatted.Consistent with migration conventions established across the documentation set.
docs/widgets/chip.mdx (1)
1-5: Metadata added without disturbing documentation content.Large properties table and JSON example preserved correctly; trailing newline properly formatted.
docs/widgets/image.mdx (1)
1-5: Front matter and formatting standardized per migration requirements.docs/widgets/listview.mdx (1)
1-5: Front matter and extensive JSON documentation properly maintained.Large example structure and properties table fully preserved; formatting updates applied consistently.
docs/widgets/grid_view.mdx (1)
1-5: Front matter and documentation structure preserved correctly.All metadata additions and trailing newline formatting applied consistently; comprehensive properties and JSON examples fully maintained.
docs/widgets/row.mdx (1)
1-5: Front matter formatting is correct and consistent.The YAML metadata follows the expected Mintlify format with proper title and description fields. The blank line separation is appropriate.
docs/widgets/circular_progress_indicator.mdx (1)
1-5: Front matter addition is consistent and properly formatted.Metadata aligns with the Mintlify migration pattern applied across all documentation files.
docs/widgets/form.mdx (1)
1-5: Proper Mintlify front matter structure applied.The YAML metadata is correctly formatted with appropriate title and description. Blank line spacing is consistent with other files in the PR.
docs/widgets/dynamic_view.mdx (1)
1-5: Excellent comprehensive documentation with proper Mintlify formatting.The front matter is correctly applied. Documentation content is extensive, well-organized, and includes multiple practical examples covering various use cases and best practices.
docs/widgets/refresh_indicator.mdx (1)
1-5: Consistent Mintlify front matter formatting applied.The YAML metadata structure matches the established pattern across all documentation files being migrated.
docs/widgets/container.mdx (1)
1-5: Proper Mintlify metadata structure applied consistently.The YAML front matter aligns with the documentation migration pattern. Formatting and content structure are appropriate.
docs/widgets/network_widget.mdx (1)
1-5: Front matter formatting is consistent and correct.The YAML metadata structure is properly applied following the Mintlify migration standard established across all files.
docs/widgets/webview.mdx (1)
1-5: Proper Mintlify front matter applied with comprehensive documentation.The YAML metadata structure is correctly formatted. Documentation includes helpful setup instructions and clear examples for WebView integration.
docs/widgets/dropdown_menu.mdx (1)
1-5: Comprehensive file migrated cleanly.This larger documentation file is consistently structured and all content (two widget sections, detailed properties, nested JSON examples) is preserved intact. Front matter follows the established pattern.
docs/widgets/colored_box.mdx (1)
1-5: Consistent migration pattern applied.Structure and front matter follow the established template. Content is preserved and formatting is correct.
docs/widgets/clip_rrect.mdx (2)
1-5: Comprehensive widget documentation cleanly migrated.The extensive ClipRRect documentation (usage patterns, multiple border radius format options, clip behavior specifications, and examples) is all preserved. Front matter applied consistently.
153-154: Related Widgets bullet formatting corrected.Minor improvement: the Related Widgets section now displays both items as clean, single-line bullets. The formatting is now consistent and readable.
docs/widgets/visibility.mdx (1)
1-5: Migration complete and consistent.Front matter, properties documentation, and dual example JSON blocks (visible and hidden states) are all preserved. Structure follows established pattern.
docs/widgets/ink_well.mdx (1)
1-5: Extensive InkWell documentation successfully migrated.The comprehensive properties table (40+ entries including various tap callbacks, color/styling options, and accessibility properties) and detailed example JSON are fully preserved. Front matter applied consistently.
docs/widgets/check_box.mdx (1)
1-5: CheckBox documentation cleanly migrated.Properties table and example JSON preserved completely. Front matter structure follows the consistent pattern established across all 8 widget documentation files.
docs/project_structure.mdx (1)
1-23: Project structure documentation is well-organized.The ASCII diagram and file descriptions clearly convey the layout. Front matter is properly formatted. No issues identified.
docs/get_started.mdx (1)
1-150: Get Started guide is comprehensive and well-structured.The documentation clearly covers installation, initialization, and three rendering patterns with correct Dart examples. Package links and pub.dev badges enhance discoverability. Front matter is properly formatted. No issues identified.
docs/widgets/column.mdx (1)
1-47: Front matter and formatting standardized.The addition of YAML front matter and trailing newline aligns with Mintlify documentation standards and matches formatting updates across other widget documentation files in this PR. No issues identified.
docs/widgets/aspect_ratio.mdx (1)
1-36: Front matter and formatting standardized.The addition of YAML front matter and trailing newline is consistent with the migration to Mintlify and matches other widget documentation files. No issues identified.
docs/actions/navigate.mdx (1)
1-98: Front matter and formatting standardized.The addition of YAML front matter and trailing newline follows Mintlify standards and is consistent across action documentation files. No issues identified.
docs/actions/none.mdx (1)
1-17: Front matter and formatting standardized.The YAML front matter addition and trailing newline are consistent with Mintlify migration standards. No issues identified.
docs/actions/modal_bottom_sheet.mdx (1)
1-88: Front matter and formatting standardized.The addition of YAML front matter and trailing newline follows Mintlify standards and is consistent across action documentation files. No issues identified.
docs/actions/get_form_value.mdx (2)
1-25: Front matter and formatting applied consistently.The addition of YAML front matter with title and description, along with proper trailing newlines, aligns with the Mintlify migration pattern. Content and code examples are preserved correctly.
1-5: YAML front matter is correctly formatted for Mintlify.The current format uses triple dashes (---) delimiters and includes both the required
titlefield and optionaldescriptionfield, which is compatible with Mintlify's documentation parser. No changes are required.docs/widgets/outlined_button.mdx (1)
1-45: Consistent Mintlify migration formatting applied.Front matter, table structures, and JSON examples all properly formatted. The blank line after front matter and trailing newline follow the migration pattern seen across documentation files.
docs/actions/network_request.mdx (1)
1-75: Migration formatting applied consistently.YAML front matter, complex nested tables, and multi-part JSON examples all preserved correctly. Trailing newline ensures proper file termination for Mintlify processing.
docs/actions/multi_action.mdx (1)
1-83: Mintlify migration formatting consistent.YAML front matter, complex nested JSON examples with multiple action types, and trailing newlines properly applied.
docs/widgets/page_view.mdx (1)
1-83: Comprehensive documentation structure maintained through migration.YAML front matter applied, large properties table (14 rows) and multi-page JSON example preserved with proper formatting and trailing newline.
docs/actions/form_validate.mdx (1)
1-39: Front matter and formatting applied correctly.YAML metadata added, content and code example preserved with proper trailing newline.
docs/actions/dialog.mdx (1)
1-56: Multiple code examples preserved correctly through migration.YAML front matter applied, properties table, and three separate JSON example blocks all maintained with proper formatting and trailing newline.
docs/widgets/safe_area.mdx (1)
1-37: Consistent Mintlify migration formatting applied.YAML front matter, properties table with detailed descriptions, and JSON example all properly preserved with correct trailing newline.
docs/introduction.mdx (1)
71-78: Standardize Discord invite URLs.The Discord href uses
discord.com/invite/but the navbar link in docs.json (line 192) usesdiscord.gg/. Both point to the same server but should use the same URL format for consistency.Verify the correct canonical Discord URL and ensure it matches across both files:
<Card title="Discord Community" icon="discord" - href="https://discord.com/invite/vTGsVRK86V" + href="https://discord.gg/vTGsVRK86V" horizontal
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/widgets/sliver_app_bar.mdx (1)
12-46: Resolve duplicatetitleSpacingproperty in the table.The properties table defines
titleSpacingtwice:
- Line 24: "The spacing around the title."
- Line 36: "The spacing around title content on the horizontal axis."
Remove the duplicate entry and clarify which definition is correct. If these represent different concepts, rename one accordingly to avoid ambiguity in the documentation.
🧹 Nitpick comments (2)
docs/widgets/sized_box.mdx (1)
1-4: YAML front matter is properly formatted for Mintlify.The front matter includes appropriate metadata (title and description) with correct delimiter placement. This aligns well with the Mintlify migration goal.
Consider verifying whether additional front matter fields (e.g.,
icon,sidebarTitle,description_override) should be included based on your Mintlify configuration to enhance discoverability or navigation in the documentation site.docs/introduction.mdx (1)
30-36: Normalize Card component indentation for consistency.Some Card components have inconsistent indentation patterns. While functionally equivalent in MDX, normalizing indentation improves readability and maintainability.
- <Card + <Card title="Stac CLI" icon="square-terminal" href="/cli" >Similarly, normalize the indentation on lines 51–57 to match the first Card (lines 23–29).
Also applies to: 51-57
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (86)
docs/actions/delay_action.mdx(2 hunks)docs/actions/dialog.mdx(2 hunks)docs/actions/form_validate.mdx(2 hunks)docs/actions/get_form_value.mdx(2 hunks)docs/actions/modal_bottom_sheet.mdx(2 hunks)docs/actions/multi_action.mdx(2 hunks)docs/actions/navigate.mdx(2 hunks)docs/actions/network_request.mdx(2 hunks)docs/actions/none.mdx(2 hunks)docs/actions/snack_bar.mdx(2 hunks)docs/cli.mdx(1 hunks)docs/introduction.mdx(1 hunks)docs/quickstart.mdx(1 hunks)docs/styles/stac_alignment_directional.mdx(2 hunks)docs/widgets/alert_dialog.mdx(2 hunks)docs/widgets/align.mdx(2 hunks)docs/widgets/app_bar.mdx(2 hunks)docs/widgets/aspect_ratio.mdx(2 hunks)docs/widgets/auto_complete.mdx(2 hunks)docs/widgets/backdrop_filter.mdx(2 hunks)docs/widgets/bottom_navigation_bar.mdx(5 hunks)docs/widgets/card.mdx(2 hunks)docs/widgets/carousel_view.mdx(2 hunks)docs/widgets/center.mdx(2 hunks)docs/widgets/check_box.mdx(2 hunks)docs/widgets/chip.mdx(2 hunks)docs/widgets/circle_avatar.mdx(2 hunks)docs/widgets/circular_progress_indicator.mdx(2 hunks)docs/widgets/clip_oval.mdx(2 hunks)docs/widgets/clip_rrect.mdx(2 hunks)docs/widgets/colored_box.mdx(2 hunks)docs/widgets/column.mdx(2 hunks)docs/widgets/container.mdx(2 hunks)docs/widgets/custom_scroll_view.mdx(2 hunks)docs/widgets/drawer.mdx(2 hunks)docs/widgets/dropdown_menu.mdx(3 hunks)docs/widgets/dynamic_view.mdx(2 hunks)docs/widgets/elevated_button.mdx(2 hunks)docs/widgets/expanded.mdx(2 hunks)docs/widgets/filled_button.mdx(2 hunks)docs/widgets/fitted_box.mdx(2 hunks)docs/widgets/flexible.mdx(2 hunks)docs/widgets/floating_action_button.mdx(2 hunks)docs/widgets/form.mdx(2 hunks)docs/widgets/fractionally_sized_box.mdx(2 hunks)docs/widgets/gesture_detector.mdx(2 hunks)docs/widgets/grid_view.mdx(2 hunks)docs/widgets/icon.mdx(2 hunks)docs/widgets/icon_button.mdx(2 hunks)docs/widgets/image.mdx(2 hunks)docs/widgets/ink_well.mdx(2 hunks)docs/widgets/limited_box.mdx(2 hunks)docs/widgets/linear_progress_indicator.mdx(2 hunks)docs/widgets/list_tile.mdx(2 hunks)docs/widgets/listview.mdx(2 hunks)docs/widgets/network_widget.mdx(2 hunks)docs/widgets/opacity.mdx(2 hunks)docs/widgets/outlined_button.mdx(2 hunks)docs/widgets/padding.mdx(2 hunks)docs/widgets/page_view.mdx(2 hunks)docs/widgets/placeholder.mdx(2 hunks)docs/widgets/positioned.mdx(2 hunks)docs/widgets/radio_group.mdx(2 hunks)docs/widgets/refresh_indicator.mdx(2 hunks)docs/widgets/row.mdx(2 hunks)docs/widgets/safe_area.mdx(2 hunks)docs/widgets/scaffold.mdx(2 hunks)docs/widgets/single_child_scroll_view.mdx(2 hunks)docs/widgets/sized_box.mdx(2 hunks)docs/widgets/slider.mdx(2 hunks)docs/widgets/sliver_app_bar.mdx(2 hunks)docs/widgets/spacer.mdx(2 hunks)docs/widgets/stack.mdx(2 hunks)docs/widgets/switch.mdx(2 hunks)docs/widgets/tab_bar.mdx(5 hunks)docs/widgets/table.mdx(2 hunks)docs/widgets/table_cell.mdx(2 hunks)docs/widgets/table_row.mdx(2 hunks)docs/widgets/text.mdx(2 hunks)docs/widgets/text_button.mdx(2 hunks)docs/widgets/text_field.mdx(2 hunks)docs/widgets/text_form_field.mdx(2 hunks)docs/widgets/vertical_divider.mdx(2 hunks)docs/widgets/visibility.mdx(2 hunks)docs/widgets/webview.mdx(2 hunks)docs/widgets/wrap.mdx(2 hunks)
✅ Files skipped from review due to trivial changes (6)
- docs/actions/none.mdx
- docs/widgets/floating_action_button.mdx
- docs/widgets/grid_view.mdx
- docs/widgets/padding.mdx
- docs/widgets/network_widget.mdx
- docs/widgets/fitted_box.mdx
🚧 Files skipped from review as they are similar to previous changes (60)
- docs/widgets/ink_well.mdx
- docs/actions/get_form_value.mdx
- docs/widgets/align.mdx
- docs/actions/dialog.mdx
- docs/widgets/card.mdx
- docs/widgets/stack.mdx
- docs/actions/form_validate.mdx
- docs/widgets/app_bar.mdx
- docs/widgets/text.mdx
- docs/widgets/switch.mdx
- docs/widgets/text_form_field.mdx
- docs/widgets/filled_button.mdx
- docs/widgets/vertical_divider.mdx
- docs/widgets/refresh_indicator.mdx
- docs/widgets/scaffold.mdx
- docs/widgets/gesture_detector.mdx
- docs/widgets/icon_button.mdx
- docs/widgets/flexible.mdx
- docs/widgets/table_row.mdx
- docs/widgets/circle_avatar.mdx
- docs/widgets/page_view.mdx
- docs/widgets/container.mdx
- docs/widgets/dynamic_view.mdx
- docs/widgets/webview.mdx
- docs/widgets/table_cell.mdx
- docs/widgets/radio_group.mdx
- docs/quickstart.mdx
- docs/widgets/expanded.mdx
- docs/cli.mdx
- docs/widgets/drawer.mdx
- docs/widgets/bottom_navigation_bar.mdx
- docs/widgets/table.mdx
- docs/widgets/circular_progress_indicator.mdx
- docs/widgets/listview.mdx
- docs/widgets/spacer.mdx
- docs/widgets/slider.mdx
- docs/actions/network_request.mdx
- docs/widgets/custom_scroll_view.mdx
- docs/widgets/positioned.mdx
- docs/widgets/alert_dialog.mdx
- docs/widgets/image.mdx
- docs/actions/modal_bottom_sheet.mdx
- docs/widgets/clip_oval.mdx
- docs/widgets/row.mdx
- docs/widgets/list_tile.mdx
- docs/widgets/colored_box.mdx
- docs/widgets/opacity.mdx
- docs/widgets/backdrop_filter.mdx
- docs/widgets/fractionally_sized_box.mdx
- docs/widgets/form.mdx
- docs/widgets/tab_bar.mdx
- docs/widgets/visibility.mdx
- docs/actions/multi_action.mdx
- docs/widgets/column.mdx
- docs/actions/delay_action.mdx
- docs/widgets/check_box.mdx
- docs/widgets/wrap.mdx
- docs/widgets/limited_box.mdx
- docs/widgets/text_field.mdx
- docs/widgets/aspect_ratio.mdx
🧰 Additional context used
🪛 LanguageTool
docs/introduction.mdx
[grammar] ~11-~11: Ensure spelling is correct
Context: ...get in Flutter, you define your UI as Stac Widgets that render at runtime from J...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/styles/stac_alignment_directional.mdx
[grammar] ~6-~6: Ensure spelling is correct
Context: ...on for StacAlignmentDirectional" --- # StacAlignmentDirectional Stac AlignmentDirectional allows you to ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (28)
docs/widgets/placeholder.mdx (1)
1-5: YAML front matter correctly formatted for Mintlify.The migration from Docusaurus to Mintlify is properly executed with the addition of appropriate metadata. The title and description fields are clearly defined and the content remains intact.
docs/widgets/auto_complete.mdx (2)
1-4: YAML front matter properly structured for Mintlify.The front matter is correctly formatted with appropriate metadata. Title and description fields follow the standard Mintlify convention.
6-33: Content and formatting intact.The documentation content, including the properties table and example JSON, is properly preserved. The trailing newline after the closing code fence ensures consistent EOF formatting across the documentation set, aligning with best practices for static documentation generators like Mintlify.
docs/styles/stac_alignment_directional.mdx (1)
1-4: LGTM!The YAML front matter is properly formatted for Mintlify conventions, the grammatical error on line 8 has been corrected ("handling" → "handle"), and the trailing newline after the code block is consistently added. These changes align with the documentation migration pattern and formatting standardization across the PR.
Also applies to: 8-8, 32-32
docs/widgets/sized_box.mdx (1)
6-24: Content structure is clear and well-organized.The documentation uses a logical hierarchy (overview → properties table → example) and includes a helpful link to the official Flutter documentation. The properties table is accessible and the JSON example is properly formatted.
docs/widgets/sliver_app_bar.mdx (2)
1-4: YAML front matter correctly formatted for Mintlify.The YAML front matter follows Mintlify documentation standards with appropriate title and description fields.
49-78: JSON example and EOF formatting look good.The example is well-formed and the code block termination with proper EOF newline follows Mintlify conventions.
docs/widgets/dropdown_menu.mdx (3)
1-4: Front matter properly formatted for Mintlify migration.The YAML front matter includes essential metadata (title, description) in the correct format with proper delimiters. This aligns well with the Mintlify documentation structure.
30-30: Heading hierarchy is appropriate for documentation structure.The use of level-2 headings for major sections (DropdownMenuEntry, Properties, Example JSON) works well under the implicit level-1 from the front matter title. The hierarchy is consistent and supports good navigation.
Also applies to: 36-36, 47-47
49-85: Code example is well-formatted and properly closed.The JSON example is valid, properly indented, and the code fence is correctly terminated with a trailing newline. The example effectively demonstrates the DropdownMenu widget configuration.
docs/widgets/single_child_scroll_view.mdx (3)
1-4: YAML front matter looks good for Mintlify migration.The front matter is properly formatted with title and description fields. This follows the expected structure for Mintlify documentation.
6-51: Content and formatting align with migration objectives.The documentation structure is clear and well-organized:
- Introductory section with reference to official Flutter docs ✓
- Comprehensive properties table with types and descriptions ✓
- Valid JSON example with proper code fence formatting (triple backticks with language identifier) ✓
- Trailing newline properly added for consistency ✓
The changes successfully modernize the documentation for Mintlify without altering the informational content.
1-51: YAML front matter consistency verified across all docs.The verification confirms that all 99 MDX files in the
/docsfolder have consistent YAML front matter withtitleanddescriptionfields. The file under review follows this established pattern correctly, and no inconsistencies were detected.docs/actions/navigate.mdx (1)
1-96: Documentation properly formatted for Mintlify.The migration from Docusaurus to Mintlify looks solid. The YAML front matter is consistent with Mintlify conventions, content is well-organized with clear sections, JSON examples are valid, and links to external documentation are preserved.
Verify that this file is properly referenced in the Mintlify navigation configuration (likely
mint.jsonor similar) to ensure it appears in the generated documentation site.docs/actions/snack_bar.mdx (1)
1-58: Documentation formatting aligns with migration objectives.The YAML front matter is properly structured, comprehensive property documentation is well-organized into two tables, and the JSON example is syntactically correct. Consistent with the Mintlify documentation format applied across the action docs.
Verify that this file is referenced correctly in the Mintlify navigation configuration and that property tables render properly on the documentation site.
docs/introduction.mdx (1)
44-50: Previous link issues successfully resolved.Both previously flagged incorrect card hrefs have been corrected:
- Actions card (line 47) now correctly points to
/actions/navigate- Theming & Styles card (line 61) now correctly points to
/concepts/themingAlso applies to: 58-64
docs/widgets/text_button.mdx (1)
1-5: YAML front matter format is correct and consistent.The front matter uses YAML-like frontmatter enclosed by triple-dashes with appropriate
titleanddescriptionfields as per Mintlify conventions. Blank line separator after the closing delimiter is correct. EOF formatting also fixed with trailing newline.docs/widgets/carousel_view.mdx (1)
1-5: Front matter and formatting consistent with other widget docs.Properly formatted YAML front matter, correct blank line separation, and EOF newline added.
docs/widgets/outlined_button.mdx (1)
1-5: Front matter format and EOF trailing newline applied correctly.All formatting standards met.
docs/widgets/safe_area.mdx (1)
1-5: Front matter and formatting consistent with PR-wide pattern.YAML structure valid; EOF newline properly added.
docs/widgets/chip.mdx (1)
1-5: Front matter properly formatted; EOF newline added.Consistent with other files in this migration batch.
docs/widgets/center.mdx (1)
1-5: Front matter and EOF formatting applied correctly.Consistent migration format.
docs/widgets/linear_progress_indicator.mdx (1)
1-5: YAML front matter and EOF formatting standards met.Consistent with migration pattern across all widget docs.
docs/widgets/icon.mdx (2)
1-5: Front matter format and EOF newline correctly applied.Consistent with all other widget documentation updates.
1-43: Recommend verifying docs.json configuration.Since this PR introduces a new Mintlify
docs.jsonconfiguration file (per the PR summary), ensure that:
- All 8 widget documentation files are properly referenced in the sidebar/navigation structure within
docs.json- No broken links or 404s result from the front-matter changes and file reorganization
- The navigation hierarchy is maintained from the old Docusaurus setup
If you can share or confirm that
docs.jsonreferences these files, that would be helpful to verify the migration completeness.docs/widgets/elevated_button.mdx (2)
1-4: YAML front matter migration looks good.The addition of proper YAML front matter aligns well with Mintlify's documentation format. The title and description fields are clear and appropriately set.
6-42: Documentation content and formatting are well-preserved.The migration cleanly maintains the documentation structure and content quality. The properties table is comprehensive, and the example JSON provides practical context. EOF formatting standardization is appropriate.
docs/widgets/clip_rrect.mdx (1)
1-4: YAML front matter is correctly formatted and consistent with all other migrated widget documentation.Verification confirms that
clip_rrect.mdxfollows the exact same YAML front matter structure used throughout the widget documentation suite, including title and description fields formatted for Mintlify conventions.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description
Migrate docs from Docusaurus to Mintlify
Add docs in the
/docsfolder and remove the deprecated/websitefolder.Type of Change
Summary by CodeRabbit
Documentation
Documentation Improvements
Chores