The "Developer Tools" documentation page serves as a critical introduction to our core development experience, but it currently undersells the value of our key investments and misses opportunities to guide users to important features. This issue outlines four areas for improvement.
1. The Developer UI Introduction Lacks a "Why"
The current introduction to the Developer UI is too brief. It explains what it is but fails to sell the value to the developer. As one of our biggest investments, the introduction should be compelling and scenario-driven.
Recommendation:
Expand the introduction to highlight the key benefits of using the Developer UI, such as:
- Rapid Iteration & Debugging: Explain that the UI allows developers to test and debug flows, prompts, and models in isolation, without needing to run their entire application. This creates a tight feedback loop.
- Visualizing AI Workflows: Emphasize that you can inspect detailed, step-by-step traces of every run. This helps developers understand exactly what's happening inside their AI logic—what inputs the model received, what it returned, and where latency occurs.
- Interactive Playground: Frame it as an interactive environment for experimenting with different models, prompts, and inputs to quickly find what works best.
2. The CLI Section is Missing init
The CLI command list omits one of the most important commands for new users: genkit init. We should make our AI-powered project scaffolding feature more discoverable.
Recommendation:
Add a bullet point to the CLI command list for genkit init. It should briefly explain that this command is used to scaffold a new Genkit project and should explicitly mention and link to the guide on using the AI-powered initialization flow.
3. Lack of Connection to Observability
The developer tools, especially the UI, are fundamentally tied to the concept of observability. The page currently misses this crucial connection, failing to guide users to the powerful tracing capabilities we've built.
Recommendation:
Add a new paragraph that explicitly connects the Developer Tools to observability. It should state that the Dev UI is the primary way to inspect traces locally and should link out to the main observability documentation, highlighting the enhanced experience available when using Firebase.
4. Side Note: The Developer UI Needs Deeper Content
This is a broader point that supports the need for the changes above. To truly drive adoption and help users master the tool, the Developer UI needs more than just a better introduction.
Recommendation (Future Work):
We should plan to create a dedicated set of pages or a section for the Developer UI. This would include detailed guides and tutorials on its various features (the Trace Inspector, the Run view, etc.), helping users move from basic awareness to proficient use.
The "Developer Tools" documentation page serves as a critical introduction to our core development experience, but it currently undersells the value of our key investments and misses opportunities to guide users to important features. This issue outlines four areas for improvement.
1. The Developer UI Introduction Lacks a "Why"
The current introduction to the Developer UI is too brief. It explains what it is but fails to sell the value to the developer. As one of our biggest investments, the introduction should be compelling and scenario-driven.
Recommendation:
Expand the introduction to highlight the key benefits of using the Developer UI, such as:
2. The CLI Section is Missing
initThe CLI command list omits one of the most important commands for new users:
genkit init. We should make our AI-powered project scaffolding feature more discoverable.Recommendation:
Add a bullet point to the CLI command list for
genkit init. It should briefly explain that this command is used to scaffold a new Genkit project and should explicitly mention and link to the guide on using the AI-powered initialization flow.3. Lack of Connection to Observability
The developer tools, especially the UI, are fundamentally tied to the concept of observability. The page currently misses this crucial connection, failing to guide users to the powerful tracing capabilities we've built.
Recommendation:
Add a new paragraph that explicitly connects the Developer Tools to observability. It should state that the Dev UI is the primary way to inspect traces locally and should link out to the main observability documentation, highlighting the enhanced experience available when using Firebase.
4. Side Note: The Developer UI Needs Deeper Content
This is a broader point that supports the need for the changes above. To truly drive adoption and help users master the tool, the Developer UI needs more than just a better introduction.
Recommendation (Future Work):
We should plan to create a dedicated set of pages or a section for the Developer UI. This would include detailed guides and tutorials on its various features (the Trace Inspector, the Run view, etc.), helping users move from basic awareness to proficient use.