docs: fix docs.page routes and simplify documentation workflows#37
docs: fix docs.page routes and simplify documentation workflows#37leoafarias merged 10 commits intomainfrom
Conversation
|
To view this pull requests documentation preview, visit the following URL: Documentation is deployed and generated using docs.page. |
|
Visit the preview URL for this PR (updated for commit 9007757): https://superdeck-dev--pr37-leoafarias-docs-docs-og6whenh.web.app (expires Sun, 08 Mar 2026 23:01:50 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bd68fc230762285849207e7e120aaf87cd4ca2f9 |
There was a problem hiding this comment.
Pull request overview
This PR updates the docs.site (docs.page) configuration and documentation content to use correct root-relative routes (no /docs prefix), and simplifies CI validation for documentation while modernizing Firebase Hosting deploy workflows. It also introduces an asset-based DeckService for runtimes that can’t rely on local processes/watchers.
Changes:
- Fix docs.page routing by removing
/docsprefixes across docs navigation and internal links, and refresh docs.json layout. - Add/adjust CI workflows: introduce a docs.page validation workflow and update Firebase Hosting workflows to target
demo/and melos-based build steps. - Add
BundledDeckServiceand updateDeckControllerBuilderto load decks from bundled assets when processes aren’t available.
Reviewed changes
Copilot reviewed 77 out of 81 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/superdeck/test/utils/uri_validator_test.dart | Formatting-only updates to test cases. |
| packages/superdeck/test/utils/converters_test.dart | Formatting-only updates to test cases. |
| packages/superdeck/test/ui/panels_test.dart | Formatting-only updates to widget tests. |
| packages/superdeck/test/testing_utils.dart | Formatting-only changes (line wrapping). |
| packages/superdeck/test/styling/schema/style_schemas_test.dart | Formatting-only changes; preserves assertions. |
| packages/superdeck/test/styling/schema/style_config_test.dart | Formatting-only changes (test layout). |
| packages/superdeck/test/rendering/slide_view_test.dart | Formatting-only changes to widget tests. |
| packages/superdeck/test/rendering/section_widget_test.dart | Formatting-only changes to widget tests. |
| packages/superdeck/test/rendering/block_widget_test.dart | Formatting-only changes to widget tests. |
| packages/superdeck/test/markdown/markdown_helpers_test.dart | Formatting-only changes (line wrapping). |
| packages/superdeck/test/markdown/image_element_rendering_test.dart | Formatting-only changes to test layout. |
| packages/superdeck/test/markdown/builders/text_element_builder_widget_test.dart | Formatting-only changes to widget tests. |
| packages/superdeck/test/helpers/layout_assertions.dart | Formatting-only changes to reason: wrapping. |
| packages/superdeck/test/flutter_test_config.dart | Formatting-only changes to mock HTTP client methods. |
| packages/superdeck/test/fixtures/slide_fixtures.dart | Formatting-only refactors to fixture constructors. |
| packages/superdeck/test/export/thumbnail_service_test.dart | Formatting-only changes; keeps existing bug/behavior tests. |
| packages/superdeck/test/deck/navigation_service_test.dart | Formatting-only change. |
| packages/superdeck/test/deck/deck_controller_test.dart | Formatting-only change. |
| packages/superdeck/test/behavior/layout_behavior_test.dart | Formatting-only changes to tests. |
| packages/superdeck/test/behavior/alignment_behavior_test.dart | Formatting-only changes to tests. |
| packages/superdeck/lib/src/utils/converters.dart | Formatting-only changes to switch/return formatting. |
| packages/superdeck/lib/src/ui/panels/bottom_bar.dart | Formatting-only changes to Watch(...) blocks. |
| packages/superdeck/lib/src/styling/schema/style_schemas.dart | Formatting-only changes to schema composition and transforms. |
| packages/superdeck/lib/src/styling/schema/style_config.dart | Formatting-only changes; minor line wrapping and signature formatting. |
| packages/superdeck/lib/src/styling/default_style.dart | Formatting-only changes. |
| packages/superdeck/lib/src/styling/components/slide.dart | Formatting-only changes to resolved spec locals. |
| packages/superdeck/lib/src/rendering/blocks/block_widget.dart | Formatting-only changes; no behavior changes intended. |
| packages/superdeck/lib/src/markdown/builders/text_element_builder.dart | Formatting-only change (wrap copyWith). |
| packages/superdeck/lib/src/export/pdf_export_screen.dart | Formatting-only changes to widget tree code. |
| packages/superdeck/lib/src/deck/navigation_service.dart | Formatting-only changes (constructor/params). |
| packages/superdeck/lib/src/deck/navigation_input_listener.dart | Formatting-only change (line wrap). |
| packages/superdeck/lib/src/deck/deck_options.dart | Documentation update clarifying watchForChanges default. |
| packages/superdeck/lib/src/deck/deck_controller_builder.dart | Select DeckService vs BundledDeckService; set enableDeckStream based on process capability. |
| packages/superdeck/lib/src/deck/bundled_deck_service.dart | New asset-based DeckService that loads .superdeck/superdeck.json via rootBundle. |
| packages/core/test/src/utils/yaml_utils_test.dart | Formatting-only change. |
| packages/core/test/src/utils/extensions_test.dart | Formatting-only change; removed stray blank line. |
| packages/core/test/src/tag_tokenizer_test.dart | Formatting-only changes to predicates/expect blocks. |
| packages/core/test/src/models/slide_model_test.dart | Formatting-only changes (list/object literals). |
| packages/core/test/src/models/deck_model_test.dart | Formatting-only changes (object literals). |
| packages/core/test/src/models/block_model_test.dart | Formatting-only changes. |
| packages/core/test/src/models/asset_model_test.dart | Formatting-only changes. |
| packages/core/test/src/deck_service_test.dart | Formatting-only changes. |
| packages/core/test/src/deck_configuration_test.dart | Formatting-only changes. |
| packages/core/lib/src/utils/extensions.dart | Formatting-only changes; message wrapped. |
| packages/core/lib/src/models/deck_model.dart | Formatting-only change to schema literal. |
| packages/core/lib/src/models/asset_model.dart | Formatting-only changes (map literal / hashCode wrap). |
| packages/core/lib/src/deck_configuration.dart | Formatting-only change (inline args). |
| packages/cli/test/src/commands/build_command_test.dart | Formatting-only changes to tests. |
| packages/cli/lib/src/utils/update_pubspec.dart | Formatting-only change (cascade formatting). |
| packages/cli/lib/src/commands/publish_command.dart | Formatting change introduced a constructor syntax error (needs fix). |
| packages/cli/lib/src/commands/build_command.dart | Formatting-only changes (line wrapping). |
| packages/builder/test/src/slide_processor_test.dart | Formatting-only changes; some argument list reflows. |
| packages/builder/test/src/parsers/fenced_code_parser_test.dart | Formatting-only changes. |
| packages/builder/test/src/deck_builder_test.dart | Formatting-only change. |
| packages/builder/test/src/assets/mermaid_generator_test.dart | Formatting-only change. |
| packages/builder/lib/src/utils/process_utils.dart | Formatting-only change (single-line Process.run). |
| packages/builder/lib/src/deck_builder.dart | Formatting-only change (Future.wait). |
| packages/builder/lib/src/assets/mermaid_generator.dart | Formatting-only change (comment spacing). |
| docs/tutorials/first-presentation.mdx | Fix route paths (remove /docs), normalize headings/titles casing. |
| docs/tutorials/block-layouts.mdx | Fix route paths and normalize headings/titles casing. |
| docs/reference/markdown-syntax.mdx | New markdown syntax reference page for blocks/widgets/frontmatter. |
| docs/reference/deck-options.mdx | Update docs for watchForChanges and fix internal links/routes. |
| docs/reference/block-types.mdx | Fix internal links/routes and normalize headings/titles casing. |
| docs/index.mdx | Fix internal links/routes and normalize headings/titles casing. |
| docs/guides/widget-size-guide.mdx | Normalize title casing. |
| docs/guides/superdeck-overview.mdx | Normalize title casing. |
| docs/guides/slide-parts.mdx | Normalize title casing and section titles. |
| docs/guides/mermaid-diagrams.mdx | Normalize title casing and section titles. |
| docs/guides/markdown-authoring.mdx | Update structure + link to new markdown syntax reference; normalize casing. |
| docs/guides/custom-widgets.mdx | Normalize title casing and section titles. |
| docs/guides/cli-reference.mdx | Document global --version; normalize casing and section titles. |
| docs/getting-started.mdx | Fix internal links/routes and normalize headings/titles casing. |
| docs/examples.mdx | Normalize headings/titles casing. |
| docs.json | Switch docs.page config to new schema/sidebar structure and remove /docs paths. |
| demo/lib/src/widgets/demo_widgets.dart | Formatting-only changes. |
| demo/lib/src/parts/header.dart | Formatting-only change. |
| demo/integration_test/helpers/test_helpers.dart | Formatting-only change. |
| demo/integration_test/app_test.dart | Formatting-only change (expect blocks). |
| .github/workflows/firebase-hosting-pull-request.yml | Update paths to demo/** and melos-based build steps; missing dependency install step. |
| .github/workflows/firebase-hosting-merge.yml | Update paths to demo/** and melos-based build steps; missing dependency install step. |
| .github/workflows/docs.yml | New workflow to run @docs.page/cli check on docs changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| PublishCommand({Logger? loggerOverride}) | ||
| : _logger = loggerOverride ?? logger { | ||
| : _logger = loggerOverride ?? logger { | ||
| argParser |
There was a problem hiding this comment.
PublishCommand constructor initializer list is syntactically invalid: : _logger = loggerOverride ?? logger { starts a block instead of terminating the initializer list. This will fail to compile; change it back to : _logger = loggerOverride ?? logger and keep the { ... } body after the initializer list.
| - name: Setup Melos | ||
| uses: bluefireteam/melos-action@v3 | ||
|
|
||
| - name: Build Runner | ||
| run: dart run build_runner build --delete-conflicting-outputs | ||
| run: melos run build_runner:build | ||
|
|
There was a problem hiding this comment.
This workflow no longer installs Dart/Flutter dependencies (e.g., flutter pub get or melos bootstrap) before running melos run build_runner:build. In this repo’s test.yml workflow dependencies are installed explicitly, so this job is likely to fail with missing packages. Add a dependency install step consistent with test.yml (or run melos bootstrap) before build_runner.
Summary
/docsprefixes in navigation and internal linksdocs/assets/logo.pngDeckOptions.watchForChangesand CLI global--versiondocs.yml)demo/and workspace-impacting changes, and remove redundant setup stepsWhy
/docs/...resolve to 404 on docs.pageexample/**pathsValidation
npx --yes @docs.page/cli checkdart analyze lib/src/deck/deck_options.dartmcp__dart__analyze_fileson workspace root/docs/prefixes in docs links/navigation