Overhaul AI documentation architecture and getting started guides - #13778
Conversation
- Centralize coding assistant setup instructions in /ai/get-started with tabs for Antigravity, Claude Code, Cursor, GitHub Copilot, Codex, and generic MCP clients. - Add /ai/tools explaining agent skills, the Dart and Flutter MCP server, Developer Knowledge MCP server, package skills, AI rules, and custom agents. - Add /ai/package-skills for app developers and package authors. - Cross-link package skills in /packages-and-plugins guides and sidebar. - Remove redundant and deprecated pages (/ai/create-with-ai, /ai/coding-assistants/*, /ai/agent-skills, /ai/mcp-server, /ai/ai-rules, /ai/best-practices/developer-experience, /ai/evals). - Configure 301 redirects for all removed pages in sites/docs/firebase.json. - Update sidebar navigation in default.yml and fix cross-site links.
f61b03b to
e1c06ee
Compare
|
Staged preview of the updated docs.flutter.dev site (updated for commit 8338a0e): https://flutter-docs-prod--docs-pr13778-ai-docs-overhaul-robeno19.web.app |
|
Staged preview of the updated flutter.dev site (updated for commit 8338a0e): https://flutter-dev-230821--www-pr13778-ai-docs-overhaul-grh8yqwe.web.app |
- Update CLI binary name to agy. - Replace placeholder command with MCP JSON config and universal skills installation.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request reorganizes and consolidates the AI-assisted development documentation for Flutter and Dart. It removes several redundant or outdated markdown files (such as agent-skills.md, ai-rules.md, antigravity.md, and mcp-server.md) and introduces two new guides: package-skills.md and tools.md. Additionally, it updates the get-started.md guide to serve as a comprehensive entry point for setting up various AI coding assistants, and updates relevant links, redirects, and the sidebar navigation accordingly. The review feedback highlights an outdated global configuration path for the Antigravity CLI and points out multiple instances of an invalid Dart CLI command syntax (using skills@ instead of skills).
sfshaza2
left a comment
sfshaza2
left a comment
There was a problem hiding this comment.
@jesskuras, this is a great overhaul! I leave the technical accuracy to the tech reviewers (and the bot certainly has thoughts), but I spent some time on the staged site and it's so much cleaner, more concise, and clearer. I'm glad that the AI tab (which I'm not a fan of and would prefer to delete) just takes you to the same pages as the sidenav that you've restored. I know you have some feedback to incorporate, but I'm going to lgtm this so you can land when ready!
lamek
left a comment
lamek
left a comment
There was a problem hiding this comment.
LGTM.
Much cleaner, great update Jess.
Co-authored-by: Jacob MacDonald <jakemac@google.com>
Co-authored-by: John Ryan <ryjohn@google.com>
Co-authored-by: John Ryan <ryjohn@google.com>
Co-authored-by: Shams Zakhour <44418985+sfshaza2@users.noreply.github.com>
|
|
||
| [Antigravity](https://antigravity.google/) is a suite of agentic development | ||
| tools built by Google that includes the Antigravity IDE and Antigravity CLI. | ||
| [Antigravity](https://antigravity.google/) is an agentic development platform |
There was a problem hiding this comment.
could this link go to the antigravity build by google plugin page where they mention our plugin and the contents of it?
https://antigravity.google/docs/build-with-google/#dart-and-flutter
| </Tab> | ||
|
|
||
| <Tab name="Cursor"> | ||
| <Tab name="Codex"> |
There was a problem hiding this comment.
(super nit) could codex go before github co pilot
There was a problem hiding this comment.
No problem, reordered them.
| * To give your assistant search access to official Flutter and Dart | ||
| documentation, connect to the [Developer Knowledge MCP server]( | ||
| https://developers.google.com/knowledge/mcp). | ||
| * To explore or contribute to the official plugins, check out the |
There was a problem hiding this comment.
currently we arent open for contributions.. havent figured out that process yet. can we just say explore more?
There was a problem hiding this comment.
Ooh sure, updated.
| {:.table .table-striped} | ||
|
|
||
| :::note | ||
| **Measuring AI tooling quality:** To learn how Flutter and Dart measure |
There was a problem hiding this comment.
this is in active construction and nothing to see here... can we remove this for now and when we have something lets add this back in?
There was a problem hiding this comment.
Sure thing, removed for now.
| When you install an official Flutter agent plugin, it connects your assistant | ||
| to two core capabilities: | ||
|
|
||
| * **Agent skills**: On-demand procedural guides from the official Flutter and |
There was a problem hiding this comment.
could this link to the other page where you talk about them? ignore if that is overkill
There was a problem hiding this comment.
Oh yeah, I'm fine adding in links, sounds good to me.
| * **Agent skills**: On-demand procedural guides from the official Flutter and | ||
| Dart repositories that teach the assistant how to perform specific tasks, | ||
| such as creating responsive layouts, managing state, or writing widget tests. | ||
| * **Dart and Flutter MCP server**: A Model Context Protocol (MCP) server that |
There was a problem hiding this comment.
same comment as above for agent skills, should this link to other page where you dive into it more. ignroe if overkill
mariamhas
left a comment
mariamhas
left a comment
There was a problem hiding this comment.
Overall this is exactly what i was looking for with the feedback i provided last time. Thank you! left some comments to consider before merging
…ks, streamline next steps
7 participants
Description
This PR overhauls the content and information architecture of the Flutter AI documentation (
docs.flutter.dev/ai), unifying getting started workflows, consolidating conceptual guides, and removing outdated / redundant pages.Key Changes
/ai/get-started:/ai/tools:/ai/package-skills:dart run skills@ get.skills/<package_name>/SKILL.md./packages-and-plugins/using-packagesand/packages-and-plugins/developing-packages./ai/create-with-ai,/ai/coding-assistants/*,/ai/antigravity*,/ai/agent-skills,/ai/mcp-server,/ai/ai-rules,/ai/best-practices/developer-experience, and/ai/evals.sites/docs/firebase.jsonfor all removed routes.sites/docs/src/data/sidenav/default.yml.index.md,llms.txt,hot-reload.md, etc.).