docs: Migrate docs from /website to /docs #374
Conversation
This is a merge commit the virtual branches in your workspace. Due to GitButler managing multiple virtual branches, you cannot switch back and forth between git branches and virtual branches easily. If you switch to another branch, GitButler will need to be reinitialized. If you commit on this branch, GitButler will throw it away. Here are the branches that are currently applied: - dv/docs (refs/gitbutler/dv/docs) branch head: d061a1b - docs/concepts/parsers.mdx - docs/widgets/app_bar.mdx - docs/why_stac.mdx - docs/widgets/ink_well.mdx - docs/actions/dialog.mdx - docs/widgets/wrap.mdx - docs/actions/form_validate.mdx - docs/widgets/chip.mdx - docs/widgets/bottom_navigation_bar.mdx - docs/actions/snack_bar.mdx - docs/widgets/single_child_scroll_view.mdx - docs/widgets/list_tile.mdx - docs/widgets/text_field.mdx - docs/widgets/vertical_divider.mdx - docs/widgets/dropdown_menu.mdx - docs/widgets/grid_view.mdx - docs/index.mdx - docs/actions/get_form_value.mdx - docs/widgets/table_cell.mdx - docs/widgets/fitted_box.mdx - docs/widgets/webview.mdx - docs/widgets/text_button.mdx - docs/widgets/linear_progress_indicator.mdx - docs/widgets/icon_button.mdx - docs/styles/clip_behavior.mdx - docs/widgets/fractionally_sized_box.mdx - docs/styles/border_radius.mdx - docs/widgets/positioned.mdx - docs/widgets/refresh_indicator.mdx - docs/actions/modal_bottom_sheet.mdx - docs/widgets/drawer.mdx - docs/actions/network_request.mdx - docs/widgets/clip_rrect.mdx - docs/widgets/outlined_button.mdx - docs/widgets/table_row.mdx - docs/concepts/action_parsers.mdx - docs/widgets/safe_area.mdx - docs/widgets/flexible.mdx - docs/widgets/sized_box.mdx - docs/widgets/table.mdx - docs/widgets/scaffold.mdx - docs/widgets/align.mdx - docs/widgets/page_view.mdx - docs/widgets/network_widget.mdx - docs/widgets/circle_avatar.mdx - docs/widgets/backdrop_filter.mdx - docs/widgets/image.mdx - docs/widgets/carousel_view.mdx - docs/widgets/card.mdx - docs/widgets/aspect_ratio.mdx - docs/styles/table_border.mdx - docs/styles/colors.mdx - docs/styles/box_fit.mdx - docs/favicon.svg - docs/widgets/dynamic_view.mdx - docs/widgets/row.mdx - docs/docs.json - docs/concepts/theming.mdx - docs/actions/delay_action.mdx - docs/widgets/filled_button.mdx - docs/widgets/sliver_app_bar.mdx - docs/widgets/clip_oval.mdx - docs/widgets/circular_progress_indicator.mdx - docs/styles/border.mdx - docs/widgets/container.mdx - docs/widgets/visibility.mdx - docs/widgets/expanded.mdx - docs/widgets/column.mdx - docs/widgets/auto_complete.mdx - docs/widgets/tab_bar.mdx - docs/widgets/custom_scroll_view.mdx - docs/widgets/placeholder.mdx - docs/widgets/elevated_button.mdx - docs/widgets/switch.mdx - docs/widgets/listview.mdx - docs/widgets/check_box.mdx - docs/widgets/gesture_detector.mdx - docs/actions/multi_action.mdx - docs/widgets/stack.mdx - docs/actions/navigate.mdx - docs/styles/table_column_width.mdx - docs/widgets/icon.mdx - docs/widgets/opacity.mdx - docs/widgets/padding.mdx - docs/widgets/floating_action_button.mdx - docs/widgets/center.mdx - docs/widgets/alert_dialog.mdx - docs/widgets/form.mdx - docs/widgets/text_form_field.mdx - docs/logo/light.svg - docs/widgets/limited_box.mdx - docs/widgets/text.mdx - docs/widgets/radio_group.mdx - docs/actions/none.mdx - docs/docs_temp.json - docs/widgets/spacer.mdx - docs/widgets/colored_box.mdx - docs/widgets/slider.mdx - docs/styles/stac_alignment_directional.mdx - docs/styles/border_side.mdx - docs/logo/dark.svg For more information about what we're doing here, check out our docs: https://docs.gitbutler.com/features/virtual-branches/integration-branch
- Renamed project from "Mint Starter Kit" to "Stac" in docs.json. - Enhanced the documentation index with a new introduction and installation guide. - Expanded widget and action categories in the documentation for better organization. - Improved CSS formatting for navbar and footer styles.
…ver-Driven UI benefits and features
…w setup instructions and examples
…s and add verification note for app deployment
WalkthroughThis pull request expands the Stac documentation ecosystem by adding comprehensive MDX documentation files (CLI guide, introduction, quickstart, and getting started), updating 100+ existing documentation pages with YAML frontmatter metadata, introducing a new docs configuration file, rewriting the main package README, and bumping core package version to 1.0.0. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes The review is primarily split between: (1) verifying the consistency and correctness of 89 repetitive frontmatter additions across MDX files (quick scan for patterns), and (2) carefully reviewing the new substantial documentation pages (CLI, introduction, quickstart, get_started) and the comprehensive README rewrite for accuracy, completeness, and alignment with the actual codebase.
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 10
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
docs/widgets/custom_scroll_view.mdx (1)
29-52: Fix invalid JSON syntax in the example code block.The example JSON contains a trailing comma after the
backgroundColorproperty (line 49), which violates JSON syntax and will cause parsing failures for anyone attempting to use this example.Apply this diff to remove the trailing comma:
"backgroundColor": "primary", - } + }Or more completely:
"backgroundColor": "primary" }docs/widgets/table.mdx (1)
15-21: Fix incorrect relative paths in documentation links.The referenced files exist but are in the wrong directory path. The links reference a non-existent
styles_and_attributesdirectory, when they should reference thestylesdirectory:
- Lines 15-16:
./../styles_and_attributes/table_column_width→ should be./../styles/table_column_width- Line 18:
./../styles_and_attributes/table_border→ should be./../styles/table_border- Line 21:
./table_rowis correctFiles exist at:
docs/styles/table_column_width.mdxdocs/styles/table_border.mdxdocs/widgets/table_row.mdxdocs/widgets/spacer.mdx (1)
14-14: Critical: Corrupted Markdown table separator.Line 14 contains invalid table separator syntax with the word
--chore-----|embedded in the separator. This will break table rendering in documentation.-| flex | `int` | The flex factor to use for the spacer. Defaults to `1`. | +| flex | `int` | The flex factor to use for the spacer. Defaults to `1`. |Apply this diff to fix the table separator:
-|----------|--chore-----|---------------------------------------------------------| +|----------|-------|----------------------------------------------------|docs/actions/multi_action.mdx (1)
15-15: Minor typo in table: "syncronous" should be "synchronous". This is in the description of thesyncproperty.Apply this diff to fix the spelling:
-| sync | `bool` | Whether to execute the actions in syncronous or parallel. Defaults to `false`. | +| sync | `bool` | Whether to execute the actions in synchronous or parallel. Defaults to `false`. |
🧹 Nitpick comments (8)
docs/widgets/visibility.mdx (1)
61-61: Optional: Add trailing newline.Following POSIX convention, consider adding a trailing newline at the end of the file for consistency with common practices.
docs/widgets/app_bar.mdx (1)
1-4: Consider a more descriptive frontmatter description.The YAML frontmatter description is generic. While "Documentation for AppBar" is functional, consider providing a more specific summary that captures the key purpose of the AppBar widget, which would improve SEO and user experience.
Example:
description: "Learn how to build Flutter AppBar widgets using Stac JSON configuration. Comprehensive guide with properties and examples."Since this PR involves standardizing frontmatter across 100+ documentation pages, you may want to establish a consistent description pattern across similar widget documentation files.
docs/widgets/padding.mdx (1)
2-3: Consider enriching the description metadata.The current description ("Documentation for Padding") is generic. Consider a more specific, descriptive summary to improve discoverability and documentation quality—for example: "Build Flutter padding widgets using JSON with customizable insets and edge values."
This is optional if consistency across all migrated docs is being maintained with similar generic descriptions.
docs/widgets/fractionally_sized_box.mdx (1)
2-3: Consider enriching the description metadata for discoverability.The description "Documentation for FractionallySizedBox" is generic. For improved SEO and user browsing experience, consider a more specific description, e.g., "Learn how to build a Flutter fractionally sized box widget using JSON with Stac."
docs/widgets/outlined_button.mdx (1)
1-4: Consider a more descriptive frontmatter description for discoverability.The frontmatter description ("Documentation for OutlinedButton") is functional but generic. For better SEO and search/discovery features in doc systems, consider a brief, descriptive summary, e.g., "Learn how to build Flutter outlined button widgets with Stac using JSON configuration."
This suggestion applies if other migrated docs follow a similar pattern. If consistency is the goal, no change is needed.
docs/widgets/positioned.mdx (1)
44-44: Inconsistent heading levels for example variants.The examples for the
directional,fill, andfromRectvariants should use consistent heading levels. Currently,directionalis an H2 heading whilefillandfromRectare H3 headings. For a coherent document structure, all three variants should be at the same level.Apply this diff to align the heading levels:
-## Example JSON for `directional` +### Example JSON for `directional`This ensures all variant examples are consistently presented as subsections under the general "Example JSON" section.
Also applies to: 62-62, 79-79
docs/widgets/dynamic_view.mdx (1)
407-418: Minor content redundancy in best practices section.Lines 413 and 418 contain identical text: "Keep templates modular and reusable when possible." This is pre-existing content, but may be worth deduplicating in a future documentation cleanup pass.
docs/widgets/drawer.mdx (1)
59-59: Remove trailing whitespace after code fence.The closing code fence on line 59 appears to have trailing space(s).
-} ~``` +} +```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (12)
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/favicon.icois excluded by!**/*.icowebsite/static/img/form_screen_image.pngis excluded by!**/*.pngwebsite/static/img/framework.pngis excluded by!**/*.pngwebsite/static/img/logo.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)examples/stac_gallery/lib/default_stac_options.dart(1 hunks)examples/stac_gallery/pubspec.yaml(1 hunks)examples/stac_gallery/stac/hello_world.dart(1 hunks)packages/stac/README.md(6 hunks)packages/stac_core/pubspec.yaml(1 hunks)website/.gitignore(0 hunks)website/README.md(0 hunks)
⛔ Files not processed due to max files limit (13)
- website/docs/actions/category.json
- website/docs/concepts/category.json
- website/docs/intro.md
- website/docs/styles/category.json
- website/docs/why_stac.md
- 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 (2)
- website/README.md
- website/.gitignore
🧰 Additional context used
🪛 LanguageTool
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)
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)
packages/stac/README.md
[uncategorized] ~568-~568: The official name of this software platform is spelled with a capital “H”.
Context: ...## 👥 Maintainers - [Divyanshu Bhargava][divyanshu_github] – Core Developer - [Rahul Bisht][rahul...
(GITHUB)
[uncategorized] ~569-~569: The name of this social business platform is spelled with a capital “I”.
Context: ..._github] – Core Developer - [Rahul Bisht][rahul_linkedin] – Core Developer ## 📄 License This ...
(LINKEDIN)
🔇 Additional comments (154)
docs/widgets/placeholder.mdx (1)
1-4: LGTM! Well-formed YAML frontmatter addition.The frontmatter is correctly structured with appropriate title and description metadata for this widget documentation. Content is fully preserved.
docs/styles/clip_behavior.mdx (1)
1-5: Excellent standardization of documentation metadata.The addition of YAML frontmatter (title and description) and the blank line following it align perfectly with MDX documentation best practices. The trailing newline also adheres to POSIX conventions. These changes enhance the documentation structure and consistency across the migrated docs.
Also applies to: 25-25
docs/widgets/circular_progress_indicator.mdx (1)
1-4: LGTM!The YAML frontmatter addition is properly formatted and metadata is appropriate. The title aligns with the content heading and the description accurately reflects the documentation purpose. This follows the PR pattern of adding metadata to existing documentation files during the migration to the /docs directory.
docs/widgets/visibility.mdx (1)
1-5: LGTM! Frontmatter metadata properly added.The YAML frontmatter is correctly formatted with valid syntax and appropriate metadata. The content remains intact and properly spaced after the metadata block.
docs/widgets/floating_action_button.mdx (1)
1-5: ✓ YAML front matter and file structure look good.The YAML front matter (title and description) has been properly added and follows standard MDX conventions for documentation migrations. The metadata is semantically appropriate and will likely support site generation, navigation, and searchability. The blank line separator and trailing newline addition (line 75) are good hygiene practices for documentation files.
docs/widgets/colored_box.mdx (1)
1-29: LGTM!The YAML frontmatter has been properly added with appropriate metadata (title and description), the existing documentation content is intact and well-structured, and EOF formatting has been standardized with a trailing newline. The changes align with the documentation migration initiative.
docs/widgets/app_bar.mdx (1)
5-63: Formatting and structure look good.The file follows proper MDX conventions: YAML frontmatter is correctly formatted, the blank line separator (line 5) is present, the markdown table is well-structured, code fence is properly closed, and content organization is clear. This aligns with the documentation migration pattern described in the PR.
docs/widgets/padding.mdx (1)
1-5: YAML front matter structure looks good.The front matter is correctly formatted with proper delimiters and spacing. The structural changes align well with the documentation migration objective.
docs/widgets/refresh_indicator.mdx (1)
1-4: LGTM! Frontmatter properly formatted and documentation structure is clean.The YAML frontmatter follows standard conventions with descriptive title and description fields. The documentation is well-organized with clear sections and an appropriate reference to the official Flutter documentation.
docs/widgets/filled_button.mdx (2)
1-4: YAML frontmatter properly formatted and follows migration pattern.The addition of frontmatter metadata (title and description) aligns with the PR-wide documentation migration objectives. The structure is clean and will support documentation indexing and SEO.
6-44: Documentation content is well-structured and accurate.The widget documentation is clear, includes a comprehensive properties table, provides a valid example JSON, and references the official Flutter documentation. The formatting and code fence termination follow proper markdown conventions.
docs/widgets/elevated_button.mdx (1)
1-44: Documentation structure and formatting look good.The file properly uses YAML frontmatter with title and description metadata, maintains clean separation with a blank line, and presents widget documentation in a well-organized format. The properties table is comprehensive, and the JSON example effectively demonstrates usage with realistic values.
docs/widgets/radio_group.mdx (3)
1-4: LGTM!The YAML frontmatter addition follows standard documentation conventions and aligns with the PR's goal of enriching metadata across documentation files. The
titleanddescriptionfields are accurate and will support documentation indexing and navigation.
6-103: Content and structure look good.The documentation is well-organized with clear property tables, accurate widget references, and a representative JSON example. No content issues detected.
105-105: Trailing blank line added for consistency.This formatting adjustment aligns with documentation file standards and the broader migration pattern mentioned in the PR.
docs/widgets/check_box.mdx (3)
1-4: YAML frontmatter properly formatted.The frontmatter is correctly structured with appropriate metadata for documentation organization.
6-52: Documentation content well-structured and complete.The documentation clearly explains the CheckBox widget with a comprehensive properties table and practical example JSON.
53-53: Trailing newline convention properly applied.The file correctly ends with a newline, aligning with the documentation formatting standards across the migrated docs.
docs/widgets/table_row.mdx (3)
1-4: LGTM!Frontmatter syntax is valid and follows MDX conventions. Metadata properly captures the widget title and description.
5-18: LGTM!Markdown structure is clean and properly formatted. Table, headings, and documentation flow are well-organized. Link to Flutter documentation is correctly formatted.
20-71: LGTM!Code fence properly closes the JSON example. The fix from an incomplete fence to proper syntax (```) ensures correct MDX rendering. JSON example is valid, well-indented, and clearly demonstrates the tableRow widget structure with nested children.
docs/widgets/circle_avatar.mdx (2)
1-5: Front matter structure looks good.The YAML front matter is properly formatted with essential metadata (title and description). This follows a clean, minimal pattern suitable for documentation indexing.
8-40: Well-structured documentation with clear examples.The content is well-organized with a clear description, comprehensive properties table, and a valid JSON example that demonstrates practical usage. The link to the official Flutter documentation is helpful for users seeking deeper context.
docs/widgets/dropdown_menu.mdx (2)
1-4: YAML frontmatter properly formatted and added.The frontmatter is correctly structured with title and description metadata. This aligns with the broader documentation migration pattern across the PR.
6-87: Documentation content is well‑maintained and migration complete.The existing documentation structure is intact with clear headings, comprehensive properties tables for both DropdownMenu and DropdownMenuEntry, and a practical JSON example. The trailing newline addition (line 87) follows best practices for file formatting.
docs/widgets/fractionally_sized_box.mdx (2)
1-4: YAML frontmatter added appropriately for documentation standardization.The frontmatter is correctly formatted and aligns with the broader documentation migration effort. The title field accurately reflects the widget name and is suitable for documentation navigation.
37-37: Trailing newline fix is appropriate.The trailing newline after the code fence ensures consistent file formatting across the documentation suite, following standard Markdown conventions.
docs/widgets/outlined_button.mdx (2)
1-5: YAML frontmatter and trailing newline added cleanly.The addition of YAML frontmatter follows standard MDX conventions. The title and description fields are appropriately populated, and the trailing newline (line 5) is a formatting best practice.
6-44: Content structure and formatting look solid.The documentation is well-organized with a clear heading, contextual description with link to official Flutter docs, comprehensive properties table, and a valid example JSON. The content migrates cleanly without formatting issues.
docs/styles/table_column_width.mdx (2)
1-5: Frontmatter formatting and structure look good.YAML frontmatter is properly formatted with appropriate title and description fields. The blank line separator after the frontmatter is correct.
20-25: Code block properly closed and formatted.The JSON example has correct language identifier, proper indentation, and a closing code fence. Ensure the file has a trailing newline after the closing fence, per text file best practices.
docs/widgets/wrap.mdx (3)
1-5: YAML frontmatter migration looks good.The frontmatter is properly formatted and the blank line separation (line 5) follows MDX conventions. The title and description are descriptive and appropriate.
6-100: Documentation content preserved correctly.The existing Wrap widget documentation—including properties table and example JSON—is intact and unchanged. Structure and formatting are sound.
1-103: Verify frontmatter consistency across migration.To ensure the documentation migration is complete and uniform, please confirm that all ~100+ migrated files follow the same YAML frontmatter schema (title, description keys) and structure.
docs/widgets/form.mdx (2)
1-4: YAML frontmatter properly added and well-formatted.The metadata frontmatter follows standard MDX conventions and aligns with the PR's documentation migration goals. The structure enables downstream documentation tooling to properly index and categorize this page.
5-70: Documentation structure and code example look good.The file is well-organized with clear headings, a helpful properties table, and a realistic JSON example that demonstrates the Form widget in a practical authentication scenario. The code fence is properly closed with appropriate formatting.
docs/widgets/custom_scroll_view.mdx (1)
1-4: YAML frontmatter structure looks good.The frontmatter addition follows the expected pattern for documentation migrations. Title and description are properly formatted.
docs/widgets/positioned.mdx (1)
1-5: Frontmatter properly formatted with trailing newline.The YAML frontmatter is correctly structured with appropriate metadata for the documentation page.
docs/widgets/clip_oval.mdx (3)
1-4: YAML frontmatter is properly formatted.The frontmatter follows standard MDX conventions with correct delimiters and key-value structure. The metadata will work well for documentation generation and SEO.
6-33: Documentation structure and content are well-organized.The file is logically structured with a clear heading, introductory explanation, properties table, and practical JSON example. The widget reference link is helpful for users wanting deeper Flutter documentation.
33-33: Code fence closure properly fixed.The closing triple backticks with trailing newline have been corrected, resolving the previous formatting issue and ensuring proper MDX rendering.
docs/styles/box_fit.mdx (1)
1-5: LGTM!The YAML frontmatter addition looks good. The metadata (title and description) is appropriate and accurately reflects the documentation content. This change aligns well with the docs migration initiative.
docs/styles/stac_alignment_directional.mdx (2)
1-4: YAML frontmatter addition looks good.The metadata structure with title and description is appropriate for the documentation migration. This aligns with the project-wide formatting pass mentioned in the PR.
6-31: Content structure and formatting look solid.The heading, explanatory table, and JSON example are well-organized and provide clear documentation for the
StacAlignmentDirectionalfeature.docs/widgets/table.mdx (1)
1-4: YAML frontmatter is properly formatted.The frontmatter metadata is correctly structured for MDX documentation.
docs/widgets/gesture_detector.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly formatted and follows standard MDX conventions. The metadata fields (title, description) align with the PR's objective to add frontmatter to documentation during migration.
docs/widgets/row.mdx (1)
1-4: Frontmatter correctly added and formatted.The YAML frontmatter follows the expected structure with appropriate title and description metadata. The title aligns with the page heading.
docs/styles/border_radius.mdx (1)
1-4: Frontmatter properly structured with correct title and description.The metadata aligns with the page content, and trailing newlines have been consistently applied.
docs/widgets/linear_progress_indicator.mdx (1)
1-4: Frontmatter added correctly with appropriate metadata.Title matches the documented widget and description follows the established convention.
docs/widgets/card.mdx (1)
1-4: Frontmatter structured correctly with matching title.The metadata and formatting adjustments (code fence closure with trailing newline) align with the PR's standardization efforts across documentation files.
docs/widgets/icon.mdx (1)
1-4: Frontmatter metadata added with correct structure and title alignment.The code fence formatting has been properly adjusted to include trailing newline, maintaining consistency across the documentation suite.
docs/widgets/text.mdx (1)
1-4: Frontmatter correctly introduced with appropriate title and description.Metadata aligns with the widget documentation, and trailing newline formatting has been applied consistently.
docs/widgets/scaffold.mdx (1)
1-4: Frontmatter properly added with title matching the documented widget.The extensive properties table and example have been preserved, with code fence formatting standardized across the documentation.
docs/widgets/safe_area.mdx (1)
1-4: Frontmatter metadata correctly structured and aligned with content.Title matches the documented widget, and formatting standards have been applied consistently.
docs/widgets/limited_box.mdx (1)
1-4: Documentation frontmatter looks good.The YAML metadata is properly formatted and follows the established pattern across the documentation migration. No concerns with this change.
docs/widgets/backdrop_filter.mdx (1)
1-4: Frontmatter formatting is correct and consistent.The metadata block is properly added and aligns with the documentation standardization effort. The comprehensive content below remains intact and well-organized.
docs/widgets/sliver_app_bar.mdx (1)
1-4: Frontmatter metadata is properly added and consistently formatted.The YAML block is valid and aligns with the documentation migration pattern. The comprehensive widget documentation below remains complete and well-organized.
docs/styles/border_side.mdx (1)
1-4: Frontmatter addition is correct and properly formatted.The metadata block follows the established pattern. The documentation structure with the info callout and See Also reference is clear and helpful.
docs/widgets/image.mdx (1)
1-4: Frontmatter is correctly formatted and consistent with other files.The metadata block is properly added. The Image widget documentation is comprehensive with clear properties, enum documentation, and practical examples.
docs/styles/table_border.mdx (1)
1-4: Frontmatter metadata is correctly added and formatted.The YAML block is properly structured and follows the established pattern. The TableBorder documentation is concise and includes a practical example demonstrating the nested borderRadius configuration.
docs/widgets/align.mdx (1)
1-4: Frontmatter is correctly formatted and consistent.The YAML metadata block is properly added. The Align widget documentation is well-structured with clear properties and a practical example demonstrating nested alignment usage.
docs/widgets/network_widget.mdx (1)
1-4: Frontmatter metadata is correctly added and follows the established pattern.The YAML block is properly formatted. The NetworkWidget documentation, though brief, effectively conveys its purpose with a practical example showing authentication headers.
docs/widgets/aspect_ratio.mdx (1)
1-5: YAML frontmatter added consistently.The addition of YAML frontmatter with title and description metadata aligns with the documentation site structure. Formatting looks good.
docs/styles/border.mdx (1)
1-5: YAML frontmatter added consistently.Frontmatter structure follows the established pattern across the documentation files.
docs/widgets/fitted_box.mdx (1)
1-5: YAML frontmatter added with proper formatting.Metadata structure and spacing are consistent with the documentation migration pattern.
docs/widgets/sized_box.mdx (1)
1-5: YAML frontmatter properly added.File follows the consistent documentation metadata pattern established across the migration.
docs/widgets/table_cell.mdx (1)
1-5: YAML frontmatter consistently applied.Metadata addition aligns with documentation migration standards.
docs/widgets/icon_button.mdx (1)
1-5: YAML frontmatter added appropriately.Metadata structure is consistent with other widget documentation files in the migration.
docs/widgets/carousel_view.mdx (1)
1-5: YAML frontmatter added consistently.Metadata structure follows the established documentation migration pattern.
docs/widgets/flexible.mdx (1)
1-5: YAML frontmatter added with proper structure.Metadata follows the consistent documentation migration pattern observed across all files.
docs/widgets/container.mdx (1)
1-5: Front matter and formatting look good.The YAML front matter is correctly formatted with appropriate metadata and consistent blank-line separation.
docs/widgets/grid_view.mdx (1)
1-5: Front matter and formatting applied consistently.The YAML front matter addition and blank-line separation follow the established pattern across the documentation updates.
docs/widgets/opacity.mdx (1)
1-5: Front matter properly applied with consistent formatting.No content issues detected; metadata addition is correct.
docs/widgets/spacer.mdx (1)
19-24: Code block formatting is correct.The JSON example and closing code fence are properly formatted with appropriate trailing newline.
docs/widgets/webview.mdx (1)
1-5: Front matter and formatting applied correctly.YAML metadata is properly formatted and follows the consistent pattern across the documentation migration.
docs/widgets/expanded.mdx (1)
1-5: Front matter and formatting consistent with migration pattern.YAML metadata addition is correct; content and code examples are intact.
docs/styles/colors.mdx (1)
1-5: Front matter and formatting properly applied.YAML metadata is correctly formatted; all content sections and code examples are preserved with appropriate trailing newline.
docs/widgets/page_view.mdx (1)
1-5: Front matter and formatting applied consistently.YAML metadata is correctly formatted; complex JSON example with multiple nested pages is intact and properly formatted.
docs/widgets/center.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the widget name. Content is preserved.
docs/widgets/chip.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the widget name. Content is preserved.
docs/widgets/column.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the widget name. Content is preserved.
docs/widgets/dynamic_view.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the widget name. Comprehensive content is preserved.
docs/widgets/switch.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the widget name. Content is preserved.
docs/widgets/tab_bar.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the primary widget. Multi-widget documentation (TabBar, DefaultTabController, Tab, TabBarView) is preserved.
docs/widgets/slider.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the widget name. Content is preserved.
docs/widgets/bottom_navigation_bar.mdx (1)
1-4: Frontmatter metadata added correctly.The YAML frontmatter is properly structured and accurately reflects the primary widget. Multi-widget documentation is preserved.
docs/widgets/text_button.mdx (1)
1-5: Front matter addition looks good.The YAML front matter follows standard MDX conventions and will support documentation site features like SEO and page indexing.
docs/widgets/alert_dialog.mdx (1)
1-5: Consistent front matter standardization.The front matter addition follows the same pattern as other documentation files and maintains proper formatting.
packages/stac_core/pubspec.yaml (1)
3-3: Verify the rationale for bumping to 1.0.0.The version is being bumped from 0.2.0 to 1.0.0, which signals a major release and API stability. Ensure this aligns with semantic versioning practices and that:
- Any breaking changes are documented in a CHANGELOG
- Migration guidance exists if needed for existing users
- This bump is intentional and not an accidental change
examples/stac_gallery/pubspec.yaml (1)
40-40: Clarify the use of dev version constraint in examples.The dependency is pinned to
^1.0.0-dev.7, a pre-release version. For example projects, consider using stable versions to avoid potential instability. Verify:
- Whether a stable
1.0.0version is available- If using a dev version is intentional (and documented)
- Whether this should be updated before merge
docs/widgets/stack.mdx (1)
1-5: Front matter addition consistent with documentation standards.Follows the established pattern for widget documentation metadata.
docs/widgets/single_child_scroll_view.mdx (1)
1-5: Standardized front matter addition.Maintains consistency with other widget documentation files.
docs/concepts/parsers.mdx (1)
1-5: Smart refactoring: Moved title to front matter metadata.Removing the duplicate heading from the body content and using the front matter title is the correct approach for MDX documentation. This eliminates redundancy and allows the documentation site to control heading rendering consistently.
docs/widgets/vertical_divider.mdx (1)
1-5: Consistent documentation standardization applied.Front matter addition follows the established pattern across all widget documentation files.
docs/widgets/auto_complete.mdx (1)
1-5: ✓ Front matter and formatting look good.The YAML front matter is consistently formatted with title and description fields.
docs/widgets/ink_well.mdx (1)
1-5: ✓ Consistent front matter formatting.YAML front matter aligns with other widget documentation.
docs/concepts/theming.mdx (2)
2-3: ✓ Front matter updated consistently.The new standardized front matter with title and description aligns with other concept documentation.
61-61: GitHub link verified as current and accessible.The repository and file path are both live (HTTP 200), confirming the link on line 61 correctly points to a valid, maintained path for the
StacThemeclass.docs/widgets/drawer.mdx (1)
1-4: ✓ Front matter is standardized.YAML front matter matches the new documentation format.
docs/widgets/clip_rrect.mdx (1)
1-4: ✓ Front matter formatting is consistent.YAML front matter aligns with widget documentation standards.
docs/concepts/action_parsers.mdx (1)
2-3: ✓ Front matter standardized successfully.Title and description fields align with other concept documentation. Sidebar positioning metadata removed as expected.
docs/cli.mdx (2)
1-5: ✓ CLI documentation front matter and structure are sound.Comprehensive CLI documentation with proper Mintlify component usage. Structure and organization follow good documentation practices.
13-16: External installation scripts verified as accessible.Verification confirms both installation scripts are live and accessible:
install.sh(macOS/Linux): HTTP 200 ✓install.ps1(Windows): HTTP 200 ✓The referenced repository and scripts remain maintained and operational.
docs/docs.json (4)
1-5: ✓ JSON structure and schema reference are correct.The Mintlify configuration follows the expected schema format and includes proper theme and branding configuration.
184-199: ✓ Branding and navigation links are properly configured.Logo paths, navbar links, and primary CTA ("Go to Console") are correctly defined. Discord support link and console redirect are appropriate.
201-211: ✓ Contextual AI tools and footer configuration are well-structured.The contextual options enable useful AI-powered features (ChatGPT, Claude, Perplexity, etc.) and social links are properly configured with current handles.
20-182: All navigation page references are valid and correspond to actual documentation files.Verification confirms all 89 pages referenced in the navigation structure exist as .mdx files in the docs directory. This includes all core overview pages (introduction, quickstart, cli, project_structure), all widget pages, and all action pages. No missing files detected.
docs/get_started.mdx (4)
1-5: YAML frontmatter is properly formatted. Good use of title and description for documentation site integration.
12-16: Package table provides useful context. The table clearly distinguishes the three core packages and their purposes with helpful pub.dev links.
39-41: Note component usage is effective. The callout about version replacement is helpful for users following the guide.
65-110: Code example shows correct Stac API usage. TheStac.initialize()call andStac.fromJson()render match the async initialization pattern shown in packages/stac/README.md.docs/quickstart.mdx (6)
1-5: YAML frontmatter is properly formatted. Good title and description for SEO and site navigation.
6-10: Prerequisites are clearly specified. Correct Flutter/Dart version constraints match the recommendation in packages/stac/README.md.
30-46: CLI installation instructions are well-presented. Using tabs for different OS platforms is a good UX pattern.
71-112: CLI output examples are helpful for users. Showing sample CLI interaction helps users understand what to expect.
192-217: Code example correctly demonstrates async initialization and Stac widget usage. The full example shows best practices: importingdefaultStacOptions, asyncmain(), and using theStac(routeName:)widget.
237-241: Links to other documentation sections are consistent. References to/widgets/align,/actions/navigate, and/clialign with the new docs structure mentioned in the PR.docs/introduction.mdx (3)
1-5: YAML frontmatter is properly formatted. Title and description are appropriate for a landing page.
71-78: Discord community card is well-formatted. Good CTA for community engagement with correct invite link.
85-99: GitHub and contribution cards support open-source engagement. Links to correct GitHub repository and CONTRIBUTING.md.packages/stac/README.md (13)
17-17: WASM platform support is mentioned as new. Good to highlight expanded platform support in the intro.
19-30: Key Features section is comprehensive and well-organized. 10 features with emojis make the list scannable and engaging. Covers widgets, actions, themes, platforms, performance, customization, and debugging.
39-42: Requirements section clearly specifies minimum versions. Matches the constraints shown in docs/quickstart.mdx.
60-69: Async initialization pattern is emphasized correctly. Line 66 showsawait Stac.initialize()which matches the new API pattern documented.
92-117: Advanced Configuration example is thorough. Shows custom parsers, action parsers, Dio integration, error handling options, and debugging flags. This gives power users clear guidance.
119-158: Loading UI section clearly documents three methods. The three approaches (fromJson, fromNetwork, fromAssets) with examples are well-presented. Customization of loading/error widgets is shown too.
492-510: Code example shows correct Stac.fromNetwork usage. The example properly demonstrates:
- Async initialization with
await Stac.initialize()- Using
StacAppinstead ofMaterialAppStac.fromNetwork()with properStacNetworkRequeststructure- Correct
Method.getenum usage
516-516: Note about loading UI methods is helpful. Reminds users of the three available approaches and points to their documentation.
522-529: Links to example projects are accurate. References to stac_gallery, counter_example, movie_app, and docs all support different learning styles.
531-537: Contributing section is prominent and includes Code of Conduct. Good practice for open-source projects.
557-565: Resources section provides comprehensive links. Includes official docs, playground, website, community, package, and repo—covers all major touchpoints.
566-570: Maintainers section acknowledges core contributors. Links to GitHub and LinkedIn profiles are appropriate. Names and roles are clearly listed.
571-573: License section correctly references MIT License. Standard open-source practice.docs/actions/form_validate.mdx (2)
1-5: YAML frontmatter has been properly added. Title and description follow the pattern established across docs/actions files.
39-39: Code fence is now properly closed. Formatting fix ensures the JSON example is correctly rendered.docs/actions/get_form_value.mdx (2)
1-5: YAML frontmatter consistently applied. Matches the pattern used in form_validate.mdx and other docs files.
20-25: JSON example is complete and properly formatted. The code fence is now correctly closed, making the example renderable.docs/actions/multi_action.mdx (2)
1-5: YAML frontmatter added consistently. Aligns with the frontmatter standardization across all docs files.
83-83: Code fence is now properly closed. Complex multi-action JSON example is complete and will render correctly.docs/widgets/list_tile.mdx (3)
1-5: YAML frontmatter properly added. Title and description are descriptive and follow the established pattern.
12-38: Properties table is comprehensive. 27 properties with types and descriptions are clearly documented. Good reference for developers using ListTile.
42-136: JSON example is detailed and practical. Shows two ListTile instances with images, titles, subtitles, and trailing icons. Good template for users to reference.docs/actions/network_request.mdx (1)
1-5: LGTM! Consistent frontmatter addition.The YAML frontmatter with title and description follows the standardized documentation pattern being applied across the PR.
examples/stac_gallery/stac/hello_world.dart (1)
3-9: LGTM! Clean hello world example.The function provides a straightforward example of building a basic Stac widget with a scaffold, center, and text widget.
docs/widgets/text_form_field.mdx (1)
1-5: LGTM! Consistent frontmatter addition.The YAML frontmatter addition aligns with the documentation standardization effort across the PR.
docs/actions/modal_bottom_sheet.mdx (1)
1-5: LGTM! Consistent frontmatter addition.The frontmatter addition follows the standardized pattern being applied across all documentation files in this PR.
docs/actions/delay_action.mdx (1)
1-5: LGTM! Consistent frontmatter addition.The YAML frontmatter addition is consistent with the documentation standardization pattern across the PR.
docs/actions/none.mdx (1)
1-5: LGTM! Consistent frontmatter addition.The frontmatter addition aligns with the standardized documentation metadata pattern being applied across the PR.
docs/actions/dialog.mdx (1)
1-5: LGTM! Consistent frontmatter addition.The YAML frontmatter addition follows the standardized documentation pattern being applied consistently across the PR.
docs/actions/snack_bar.mdx (1)
1-5: LGTM! Consistent frontmatter addition.The YAML frontmatter addition is consistent with the documentation standardization effort across all MDX files in this PR.
docs/actions/navigate.mdx (1)
1-5: LGTM! Frontmatter metadata added correctly.The YAML frontmatter follows proper conventions and provides appropriate metadata for the Navigate Action documentation.
docs/widgets/text_field.mdx (1)
1-5: LGTM! Consistent frontmatter metadata.The frontmatter addition is consistent with the documentation standardization across the PR.
docs/widgets/listview.mdx (1)
1-5: LGTM! Frontmatter metadata added.The frontmatter follows the same pattern as other documentation files in this PR, providing consistent metadata structure.
docs/project_structure.mdx (1)
1-23: LGTM! Clear project structure documentation.This new documentation page provides a helpful overview of how a Stac-powered Flutter project is organized, with a clear directory tree and explanations of key files.
| # 6. Deploy to Stac Cloud | ||
| stac deploy | ||
| ``` |
There was a problem hiding this comment.
🧩 Analysis chain
Verify CLI commands match actual implementation.
The development workflow section (lines 195-211) lists several commands. Confirm that the command sequence and options documented here match the actual CLI implementation, especially around the build-before-deploy behavior mentioned in the Deployment section.
🏁 Script executed:
#!/bin/bash
# Verify that the documented commands exist in the codebase
echo "=== Searching for CLI command implementations ==="
find . -type f \( -name "*.dart" -o -name "*.ts" -o -name "*.js" \) | xargs grep -l "stac.*login\|stac.*build\|stac.*deploy" | head -10Length of output: 97
---
🏁 Script executed:
```shell
#!/bin/bash
# Step 1: View the documentation to see what commands are documented
echo "=== Examining docs/cli.mdx around lines 195-211 ==="
head -211 docs/cli.mdx | tail -25
echo ""
echo "=== Looking for CLI package/entry point ==="
find . -type f \( -name "*.dart" -o -name "*.ts" -o -name "*.js" \) -path "*/bin/*" -o -path "*/cli/*" | grep -E "(main|cli|bin)" | head -10
echo ""
echo "=== Searching for command definitions (broader pattern) ==="
rg -n "deploy|login|build" -A 2 ./packages/stac_core/lib/core/stac_options.dart | head -30
Length of output: 850
---
🏁 Script executed:
```shell
#!/bin/bash
# Step 2: Find project structure and CLI package location
echo "=== Project structure ==="
ls -la
echo ""
echo "=== Search for pubspec.yaml files ==="
find . -name "pubspec.yaml" -type f | head -10
echo ""
echo "=== Look for CLI executable or bin directory ==="
find . -type d \( -name "bin" -o -name "cli" \) | head -10
echo ""
echo "=== Check full docs/cli.mdx for Deployment section with build behavior ==="
grep -n "Deployment\|build-before-deploy\|stac build" docs/cli.mdx | head -20
echo ""
echo "=== Verify step numbering in workflow section ==="
sed -n '195,211p' docs/cli.mdx | grep -E "^# [0-9]"
Length of output: 2365
---
🏁 Script executed:
```shell
#!/bin/bash
# Step 3: Examine the stac package for CLI implementation
echo "=== Examining packages/stac/ structure ==="
find ./packages/stac -type f -name "*.dart" | head -20
echo ""
echo "=== Check packages/stac/pubspec.yaml for CLI executable definition ==="
cat ./packages/stac/pubspec.yaml | grep -A 10 -B 5 "executables\|bin"
echo ""
echo "=== Search for command implementations in stac package ==="
grep -r "stac build\|stac deploy\|stac login" ./packages/stac/lib/ 2>/dev/null | head -10
echo ""
echo "=== Verify step 5 content is truly missing ==="
sed -n '195,211p' docs/cli.mdx
Length of output: 2041
Fix step numbering in workflow—step 5 is missing.
The development workflow section (lines 195-211) has a critical formatting error: the steps jump from # 4. Create your widget definitions directly to # 6. Deploy to Stac Cloud, with no step 5. This should be corrected to sequential numbering (either restore step 5 with relevant content like stac build, or renumber step 6 to step 5).
The build-before-deploy behavior mentioned in the Deployment section (line 159: "By default, stac deploy automatically runs stac build before deploying") is consistent with the workflow not showing an explicit build step. However, verify whether step 5 should document the stac build command or if the numbering was simply edited incorrectly.
🤖 Prompt for AI Agents
In docs/cli.mdx around lines 195 to 211, the numbered workflow steps jump from
"# 4. Create your widget definitions" to "# 6. Deploy to Stac Cloud", leaving
out step 5; restore proper sequencing by either inserting a step 5 that
documents "stac build" (brief usage and note that deploy runs build by default)
or renumber the current "# 6" heading to "# 5" if no build step is needed—also
verify consistency with the note at line 159 about deploy running build and
update that line if you choose to explicitly add the build step.
| You can also use `Stac.fromAssets` to load and render the UI from a JSON file stored in the assets folder: | ||
|
|
||
| ```dart | ||
| @override | ||
| Widget build(BuildContext context) { | ||
| return MaterialApp( | ||
| title: 'StacDemo', | ||
| theme: ThemeData( | ||
| primarySwatch: Colors.blue, | ||
| ), | ||
| home: Stac.fromAsset('assets/ui.json', context), | ||
| ); | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Typo: Stac.fromAssets should be Stac.fromAsset. Line 114 says "use Stac.fromAssets" but line 124 correctly shows Stac.fromAsset in the code. Standardize the method name in the text.
Apply this diff to fix the inconsistency:
-You can also use `Stac.fromAssets` to load and render the UI from a JSON file stored in the assets folder:
+You can also use `Stac.fromAsset` to load and render the UI from a JSON file stored in the assets folder:🤖 Prompt for AI Agents
In docs/get_started.mdx around lines 114 to 127, the prose incorrectly
references Stac.fromAssets while the example uses Stac.fromAsset; update the
text so it consistently uses Stac.fromAsset (singular) to match the code sample
and the actual API name.
| <Columns cols={2}> | ||
| <Card | ||
| title="Quickstart Guide" | ||
| icon="rocket" | ||
| href="/quickstart" | ||
| > | ||
| Step-by-step guide to help your get started with Stac and learn the core features. | ||
| </Card> | ||
| <Card | ||
| title="Stac CLI" | ||
| icon="square-terminal" | ||
| href="/cli" | ||
| > | ||
| Learn how to use the Stac CLI to build, deploy, and manage Stac Cloud integrations. | ||
| </Card> | ||
| <Card | ||
| title="Widgets" | ||
| icon="layers" | ||
| href="/widgets/align" | ||
| > | ||
| Explore 70+ built-in widgets with detailed examples, and customization options. | ||
| </Card> | ||
| <Card | ||
| title="Actions" | ||
| icon="bolt" | ||
| href="/styles/colors" | ||
| > | ||
| Discover how to handle navigation, dialogs, API calls, and more using built-in action handlers. | ||
| </Card> |
There was a problem hiding this comment.
Inconsistent navigation hrefs in documentation cards. The "Actions" card (line 47) points to /styles/colors instead of /actions/navigate. This should reference the Actions section. Also, the "Theming & Styles" card (line 61) points to /concepts/parsers which doesn't match its content.
Apply this diff to fix the inconsistent hrefs:
<Card
title="Actions"
icon="bolt"
- href="/styles/colors"
+ href="/actions/navigate"
>
Discover how to handle navigation, dialogs, API calls, and more using built-in action handlers.
</Card>
<Card
title="Theming & Styles"
icon="palette"
- href="/concepts/parsers"
+ href="/styles/colors"
>
Have full control over colors, typography, and component themes on the fly.
</Card>Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/introduction.mdx around lines 22 to 50 (and note the related Theming &
Styles card at ~line 61), update the inconsistent hrefs: change the "Actions"
card href from /styles/colors to /actions/navigate, and change the "Theming &
Styles" card href from /concepts/parsers to the correct theming path (e.g.
/styles/theming or /styles) so each card links to its matching section.
| void main() async { | ||
| await Stac.initialize(options: defaultStacOptions); | ||
| runApp(const MyApp()); | ||
| } | ||
| ``` | ||
| Now that stac is initalize our app is ready to be dynamic and server driven. |
There was a problem hiding this comment.
Fix spelling and hyphenation errors on line 181. The text contains a typo ("initalize" instead of "initialize") and missing hyphen in a compound adjective ("server driven" should be "server-driven").
Apply this diff to fix the errors:
-Now that stac is initalize our app is ready to be dynamic and server driven.
+Now that Stac is initialized, our app is ready to be dynamic and server-driven.Note: Also capitalized "Stac" for consistency with the framework name convention used throughout the docs.
🧰 Tools
🪛 LanguageTool
[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)
🤖 Prompt for AI Agents
In docs/quickstart.mdx around lines 175 to 181, fix the typos and hyphenation in
the closing sentence: change "initalize" to "initialize", change "server driven"
to the hyphenated "server-driven", and ensure "Stac" is capitalized
consistently; update the line so it reads something like "Now that Stac is
initialized, our app is ready to be dynamic and server-driven."
| - [Border Side](./border_side.md) - Learn about StacBorderSide properties | ||
| - [Border Radius](./border_radius.md) - Learn about border radius configuration | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
Verify cross-reference link extensions after migration.
Lines 163-164 reference border_side.md and border_radius.md with .md extensions. If these files have been migrated to .mdx format as part of this PR, these links will be broken. Please verify and update the file extensions accordingly.
🏁 Script executed:
#!/bin/bash
# Description: Check if referenced files exist and determine correct file extensions
# Check for both .md and .mdx versions of referenced files
echo "Checking for border_side files:"
fd -e md -e mdx "border_side"
echo "Checking for border_radius files:"
fd -e md -e mdx "border_radius"
# Also check what other files reference .md extensions
echo "Checking for .md references in docs/styles/border.mdx:"
grep -n "\.md)" docs/styles/border.mdx || echo "No .md links found"Length of output: 340
Update cross-reference links to use .mdx extensions.
Lines 163-164 contain broken links. The referenced files have been migrated to .mdx format, but the links still use .md extensions:
- Change
./border_side.md→./border_side.mdx - Change
./border_radius.md→./border_radius.mdx
🤖 Prompt for AI Agents
In docs/styles/border.mdx around lines 163 to 165 the cross-reference links
point to .md files that were migrated to .mdx; update the two links to use
./border_side.mdx and ./border_radius.mdx respectively so they resolve
correctly.
|
|
||
| # StacAlignmentDirectional | ||
|
|
||
| Stac AlignmentDirectional allows you to handling alignment widget using JSON. |
There was a problem hiding this comment.
Fix grammar error.
Line 8 contains a grammatical error: "allows you to handling" should be "allows you to handle".
Apply this diff to correct the grammar:
-Stac AlignmentDirectional allows you to handling alignment widget using JSON.
+Stac AlignmentDirectional allows you to handle alignment widgets using JSON.(Note: Also pluralized "widget" to "widgets" for consistency with standard documentation style.)
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Stac AlignmentDirectional allows you to handling alignment widget using JSON. | |
| Stac AlignmentDirectional allows you to handle alignment widgets using JSON. |
🤖 Prompt for AI Agents
In docs/styles/stac_alignment_directional.mdx around line 8, fix the grammatical
error by replacing "allows you to handling" with "allows you to handle" and
pluralize "widget" to "widgets" so the sentence reads correctly and
consistently.
| - [Container](container.md) - Often used as a child of ClipRRect | ||
| - [Card](card.md) - A pre-styled container with elevation and rounded corners | ||
| - [Card](card.md) - A pre-styled container with elevation and rounded corners |
There was a problem hiding this comment.
🧩 Analysis chain
Fix internal link references to use correct file extensions.
Line 154 references links with .md extension, but the documentation files in this PR use .mdx format. Based on the docs.json navigation structure (which references pages without extensions, e.g., "widgets/card"), these links should likely reference the page names without extension or use the correct .mdx extension.
- [Container](container.md) - Often used as a child of ClipRRect
- [Card](card.md) - A pre-styled container with elevation and rounded corners
+ [Container](container.mdx) - Often used as a child of ClipRRect
+ [Card](card.mdx) - A pre-styled container with elevation and rounded cornersAlternatively, if using Mintlify's routing, verify the correct format by checking how other documentation pages handle internal links.
🏁 Script executed:
#!/bin/bash
# Check which link format is used in other MDX files in the docs directory
echo "=== Checking for .md links in MDX files ==="
rg -n '\]\([a-z_]+\.md\)' docs/
echo ""
echo "=== Checking for .mdx links in MDX files ==="
rg -n '\]\([a-z_/]+\.mdx\)' docs/
echo ""
echo "=== List actual files in docs/widgets ==="
find docs/widgets -type f -name "*.mdx" | head -10Length of output: 627
I need to gather more information about how links are handled in this documentation.
I need to check how other .mdx files handle internal links to understand the correct pattern.
🏁 Script executed:
#!/bin/bash
# Check how other MDX files handle internal links (markdown link format)
echo "=== Checking for any markdown links in other MDX files ==="
rg -n '\]\([^)]+\)' docs/ --type mdx | grep -v 'http' | head -20
echo ""
echo "=== Specifically check if container.mdx exists ==="
find docs/ -name "container.mdx" -o -name "container.md"
echo ""
echo "=== Check docs.json to see how navigation is structured ==="
cat docs.json | head -50Length of output: 268
🏁 Script executed:
#!/bin/bash
# Check internal links in other MDX files using correct syntax
echo "=== Checking markdown links in other MDX files ==="
rg -n '\]\([^)]+\)' docs/widgets/ | grep -v 'http' | head -30
echo ""
echo "=== Check for mint.json or other config ==="
find . -maxdepth 2 -name "mint.json" -o -name "docs.json" -o -name ".mintlifyrc*"
echo ""
echo "=== Check if any .md files exist ==="
find docs/ -name "*.md" -type f
echo ""
echo "=== Check what's in docs root ==="
ls -la docs/ | head -20Length of output: 2931
🏁 Script executed:
#!/bin/bash
# Check if overview.md exists and examine docs.json
echo "=== Check for overview file in actions ==="
ls -la docs/actions/ | grep overview
echo ""
echo "=== Examine docs.json structure ==="
cat docs/docs.json
echo ""
echo "=== Check if any .mdx file contains links with .mdx extension ==="
rg '\]\([^)]*\.mdx' docs/Length of output: 8012
Update link references to remove file extensions (not add .mdx).
The links use .md extension, but no .md files exist in the repository—all documentation files are .mdx. However, the correct format for this documentation is to omit file extensions entirely, which aligns with Mintlify's routing convention shown in docs.json and the pattern used in other .mdx files (e.g., ./table_cell, ./table_row without extensions).
- [Container](container.md) - Often used as a child of ClipRRect
- [Card](card.md) - A pre-styled container with elevation and rounded corners
+ [Container](container) - Often used as a child of ClipRRect
+ [Card](card) - A pre-styled container with elevation and rounded corners📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Container](container.md) - Often used as a child of ClipRRect | |
| - [Card](card.md) - A pre-styled container with elevation and rounded corners | |
| \ No newline at end of file | |
| - [Card](card.md) - A pre-styled container with elevation and rounded corners | |
| - [Container](container) - Often used as a child of ClipRRect | |
| - [Card](card) - A pre-styled container with elevation and rounded corners |
🤖 Prompt for AI Agents
In docs/widgets/clip_rrect.mdx around lines 153 to 154, the links currently
point to "container.md" and "card.md"; update them to remove the ".md" extension
to match the repository routing conventions (use the same pattern as other
files, e.g. "./container" and "./card" or "container" and "card" depending on
surrounding links) so they reference the .mdx pages without file extensions.
| For more information on actions, see the [Actions documentation](../actions/overview.md). | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
Verify the Actions reference path is valid.
The file references ../actions/overview.md for Actions documentation. Ensure this relative path resolves to the correct migrated documentation file in the new /docs directory structure.
🏁 Script executed:
#!/bin/bash
# Description: Verify that the Actions documentation reference path resolves correctly
# Expected: File should exist at the resolved path
# Resolve the relative path from docs/widgets/gesture_detector.mdx
resolved_path=$(cd docs/widgets 2>/dev/null && cd ../actions && pwd && ls overview.md 2>/dev/null && echo "✓ File exists")
if [ -z "$resolved_path" ]; then
echo "✗ File not found or path resolution failed"
exit 1
fi
# Also check for common alternative filenames that might be the target
fd -e md -e mdx "overview|actions" docs/actions/ 2>/dev/null | head -10Length of output: 0
🏁 Script executed:
#!/bin/bash
# Direct verification of the Actions documentation file
# Check if the target file exists
if [ -f "docs/actions/overview.md" ]; then
echo "✓ File found: docs/actions/overview.md"
else
echo "✗ File NOT found: docs/actions/overview.md"
fi
# List contents of docs/actions to see actual files
echo ""
echo "Contents of docs/actions/:"
ls -la docs/actions/ 2>/dev/null || echo "✗ docs/actions/ directory not found"
# Verify docs/widgets directory exists
echo ""
echo "Verifying docs/widgets/gesture_detector.mdx exists:"
if [ -f "docs/widgets/gesture_detector.mdx" ]; then
echo "✓ File found"
else
echo "✗ File NOT found"
fiLength of output: 899
🏁 Script executed:
#!/bin/bash
# Check for index or category files that might serve as overview
echo "Searching for potential overview or index files:"
ls -la docs/actions/ | grep -E "(index|_category_|README)"
echo ""
echo "All files in docs/actions/:"
ls -1 docs/actions/
echo ""
echo "Checking content of gesture_detector.mdx for the specific reference:"
grep -n "actions/overview" docs/widgets/gesture_detector.mdxLength of output: 402
🏁 Script executed:
#!/bin/bash
# Check for documentation configuration files
echo "Searching for category or configuration files in docs/:"
find docs/actions/ -name "_category_*" -o -name "*.json" -o -name "sidebars*" 2>/dev/null
echo ""
echo "Checking parent docs directory:"
find docs/ -maxdepth 2 -name "_category_*" 2>/dev/null | head -5
echo ""
echo "Checking if there's a root docs config:"
ls -la docs/*.json docs/*.js 2>/dev/null | head -10Length of output: 193
Fix broken Actions documentation reference path.
The file docs/actions/overview.md referenced at line 213 does not exist. The docs/actions/ directory contains only individual action files (all in .mdx format), with no overview file. Either create docs/actions/overview.mdx to serve as an Actions documentation index, or update the reference to point to an existing action file.
🤖 Prompt for AI Agents
In docs/widgets/gesture_detector.mdx around lines 213-214 the link points to
../actions/overview.md which doesn't exist; either create a new
docs/actions/overview.mdx as an index page (and ensure it exports the actions
overview content) or update the link to a valid existing file in docs/actions/
(use the .mdx extension and correct relative path), then verify the link builds
correctly and update any references elsewhere if you rename the target.
| ] | ||
| } | ||
| ``` | ||
| ``` |
There was a problem hiding this comment.
Remove trailing comma from JSON array.
The JSON example contains a trailing comma after the final object in the children array (line 158), which is invalid JSON syntax and will cause parsing errors.
Apply this diff to fix the syntax error:
}
]
- }
+ }
]
}Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/widgets/table.mdx around lines 158 to 160, the JSON example contains a
trailing comma after the last object in the children array which makes the JSON
invalid; remove the trailing comma following the final object so the array ends
with ] and the surrounding object/JSON remains syntactically correct.
| StacOptions get defaultStacOptions => StacOptions( | ||
| name: 'Demo', | ||
| description: 'dededededededed', | ||
| projectId: 'KwwEhv9aBvdlMn8aRLuy', | ||
| ); |
There was a problem hiding this comment.
Replace placeholder description with meaningful text.
Line 24 contains 'dededededededed' as the description value, which appears to be placeholder text. Since this is example code that developers will reference, consider using a more descriptive value like 'Stac Gallery Demo Application' or similar.
Apply this diff to use a meaningful description:
StacOptions get defaultStacOptions => StacOptions(
name: 'Demo',
- description: 'dededededededed',
+ description: 'Stac Gallery Demo Application',
projectId: 'KwwEhv9aBvdlMn8aRLuy',
);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| StacOptions get defaultStacOptions => StacOptions( | |
| name: 'Demo', | |
| description: 'dededededededed', | |
| projectId: 'KwwEhv9aBvdlMn8aRLuy', | |
| ); | |
| StacOptions get defaultStacOptions => StacOptions( | |
| name: 'Demo', | |
| description: 'Stac Gallery Demo Application', | |
| projectId: 'KwwEhv9aBvdlMn8aRLuy', | |
| ); |
🤖 Prompt for AI Agents
In examples/stac_gallery/lib/default_stac_options.dart around lines 22 to 26,
the description field currently uses placeholder text ('dededededededed');
replace that with a meaningful description such as 'Stac Gallery Demo
Application' (or another concise, descriptive string) so the example code is
clearer for developers referencing it.
|
|
Description
Docs migration from /website to /docs folder
Type of Change
Summary by CodeRabbit
New Features
Documentation