[AI Docs] Integrate AI documentation into the default sidebar - #13735
Conversation
Integrate the standalone AI sidebar into default.yml as a dedicated top-level section header, update AI content pages to use default sidebar navigation, and remove deprecated ai.yml.
|
Staged preview of the updated docs.flutter.dev site (updated for commit 1fb4c8a): https://flutter-docs-prod--docs-pr13735-ai-sidenav-migration-kr3sd4jg.web.app |
|
Staged preview of the updated flutter.dev site (updated for commit 1fb4c8a): https://flutter-dev-230821--www-pr13735-ai-sidenav-migration-y15stxi6.web.app |
sfshaza2
left a comment
There was a problem hiding this comment.
I know this is a draft, @jesskuras, but this was MUCH NEEDED. Thanks! I'm ok with adding this, sooner than later, and tweaking as things evolve.
|
This looks great. I like keeping the top level "AI" tab. I think we may need at least one redirect, for the default /ai path. |
There was a problem hiding this comment.
Code Review
This pull request integrates the AI documentation navigation directly into the default sidebar configuration (default.yml) and removes the individual sidenav: ai frontmatter properties from the AI content files. Feedback on the changes suggests removing the permalink property from the "Build AI-powered apps" parent item in the sidebar to prevent it from unexpectedly navigating users directly to a sub-topic, allowing it to serve as a standard expandable container instead.
| - title: Build AI-powered apps | ||
| permalink: /ai/genui | ||
| icon: auto_awesome |
There was a problem hiding this comment.
The parent item Build AI-powered apps is configured with permalink: /ai/genui, which points directly to the GenUI SDK for Flutter page (the third child in this section). This can be confusing for users who click on the category header expecting a general overview or simply wanting to expand the section, only to be navigated directly to a specific sub-topic.
Since there is no dedicated overview page for 'Build AI-powered apps' (unlike 'Develop with AI' which naturally points to its first child 'Get started'), it is recommended to remove the permalink property from this category header. This allows it to function purely as an expandable/collapsible container, consistent with other nested sidebar categories.
- title: Build AI-powered apps
icon: auto_awesome
Thanks! I double-checked and since none of the URLs are changing (including the default /ai one) it looks like it still resolves fine. |
Integrate the standalone AI sidebar into the main default sidebar (
default.yml)under a dedicated
AItop-level section header.This migration:
- header: AIsection indefault.ymlwith top-level entries forOverview, Develop with AI, and Build AI-powered apps.
src/data/sidenav/ai.yml.