docs: refonte Get Started navigation, retire AI Builder Portal, docum… - #186
docs: refonte Get Started navigation, retire AI Builder Portal, docum…#186jul-dan wants to merge 9 commits into
Conversation
…ent Agent Tasks - Remove AI Builder Portal from the product switcher (content under docs/rde/** untouched), fix the repo-wide missing-prefix link bug and other broken links across the Get Started page group - Fix an AWS IAM policy drift between two snippets (missing servicequotas permission, duplicate dynamodb entry) and convert aws/azure/scaleway installation guides to import their credentials snippets instead of hand- duplicating them, matching the existing gcp.mdx pattern - Restructure Get Started navigation: dedupe pages listed twice in docs.json, dissolve the ambiguous "Quickstart" nav group, fork Installation into Local / Managed Cluster / BYOK, rename quickstart/docker-desktop to quickstart/docker with a redirect - Rebuild aws.mdx onto the same section skeleton as the other three cloud providers (Overview, What Gets Created, Best Practices) and strip marketing language, emojis, and em dashes across the touched pages per AGENTS.md - Realign messaging on introduction.mdx and how-it-works.mdx with qovery.com's current positioning, and rewrite the migration guide around the qovery-onboard skill - Add Agent Tasks documentation (alpha): a Getting Started overview with the ready-made use cases, and a Configuration reference with setup, automations (schedule/webhook triggers, webhook outputs), and dedicated guides for the Incident Analyser and Build & Deployment Optimizer templates Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
qovery-doc-mintlify-proxy | 07cbebf | Sep 10 2026, 03:04 PM |
navigation.products always renders a dropdown switcher in the header, even with a single product, since that's inherent to the products navigation type rather than tied to how many entries it has. Move the six tabs to navigation.tabs directly, dropping the products wrapper entirely, since there's only one product (Platform) now that AI Builder Portal is gone. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
All reported issues were addressed
Tip: cubic can generate docs of your entire codebase and keep them up to date. Try it here.
Re-trigger cubic
| <Card title="Deploy with AI Agent" icon="wand-magic-sparkles" href="/getting-started/quickstart/ai-agent"> | ||
| From code to deployed in ~10 minutes | ||
| </Card> | ||
| <Card title="All Use Cases" icon="compass" href="/getting-started/quickstart"> |
There was a problem hiding this comment.
can we make it more visible the Migration use case?
There was a problem hiding this comment.
btw, the migration use case should be the first in every list. Before the "Deploy with AI Agent"
There was a problem hiding this comment.
Indeed forgot to change in this page
| Only Anthropic is supported today, with your own API key. | ||
| </Step> | ||
| <Step title="Add MCP Servers (Optional)"> | ||
| Qovery's own MCP server is available by default in read-only mode. Add it, or connect any remote HTTPS MCP server with its own name, URL, and headers. |
There was a problem hiding this comment.
Qovery's own MCP server is available by default in read-only mode.
There was a problem hiding this comment.
I thought that this MCP was added automatically
There was a problem hiding this comment.
Ah yes it is not true, but maybe a good idea no? :)
- Move "Agent Tasks" out of the Jobs subcategory into its own Services group, and nest the two use-case guides under an "Examples" subgroup so more can be added over time - Drop the literal prompt text and exact resource/domain values from the Incident Analyser and Build & Deployment Optimizer guides, they will drift as the templates change. Explain what each agent does and how to set it up instead Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
All reported issues were addressed across 3 files (changes from recent commits).
Requires human review: Auto-approval blocked because this review re-detected 1 unresolved issue already reported by Cubic.
Tip: Review your code locally with the cubic CLI to iterate faster.
Re-trigger cubic
docs/files/qovery-iam-aws.json still had the duplicate dynamodb:* entry and was missing servicequotas:GetServiceQuota, the same drift already fixed in the aws-credentials snippets. Anyone using the "Download IAM permissions JSON" link was getting the uncorrected policy. Caught by review. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
…intro - how-it-works.mdx: the architecture diagram SVG still visually shows five product panels (never updated for Agents), so drop the numeric claim from its alt text instead of asserting a count the image doesn't show. Fix the remaining "all five products" Next Steps card to six. The SVG itself needs a real design update to add a sixth panel, out of scope here. - getting-started/agent-tasks.mdx: its Overview paragraph was a verbatim copy of configuration/agent-tasks/overview.mdx's. Rewrite it as a lighter, product-pitch intro and point to the Configuration Reference for the technical definition, so there's one place that owns it. Caught by review. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
| 4. Opens a PR with the proposed changes to the build configuration, and/or updates the build configuration in Qovery directly. | ||
| 5. Summarises what it changed, the expected gain, and anything that needs a human decision. It never merges, the human always stays the gate. | ||
|
|
||
| ## Setting It Up |
There was a problem hiding this comment.
Could we add a short walkthrough showing how to actually use this template? Which repository and MCP/API access to configure, what permissions are needed to propose versus apply changes, and how to trigger a first run and check the results
| 5. Reports its findings to the on-call human in chat: a short summary, the suspected root cause, and a recommended next step. | ||
| 6. If the fix is small and well-understood, opens a PR with the proposed change and links it in the message. It never merges, the human always stays the gate. | ||
|
|
||
| ## Setting It Up |
There was a problem hiding this comment.
Could we add a short walkthrough from setup to a first successful run? The expected behavior is clear, but users still need to know how to connect logs, metrics, and repositories, grant the required permissions, configure the incident trigger, and verify that the findings reach Slack
Co-authored-by: Rémi Bonnet <bonnet.rem@gmail.com>
…orrections - cloud-migration-and-scaling.mdx: qovery-onboard was credited with the full technical migration workflow (analyze codebase, Dockerfiles, databases, deploy), which contradicts this repo's own agent-skills.mdx and ai-agent.mdx, where that workflow belongs to qovery-deploy. qovery-onboard stays the right entry point (context, concept mapping, cluster setup), qovery-deploy now owns the execution steps - introduction.mdx and quickstart.mdx: give the migration use case a "Migrate to Kubernetes" card and move it first, before "Deploy with AI Agent", per review feedback - Qovery's own MCP server is not added automatically, fix the three places that said otherwise (agent-tasks/overview.mdx, agent-tasks/build-deployment-optimizer.mdx, organization.mdx) to say it must be added manually (https://mcp.qovery.com/mcp), and link to the API Policy Token doc for scoped access instead of overclaiming the endpoint itself is read-only - agent-tasks/overview.mdx: reword an output example per review ("For example, to post...") and stop implying Agent Tasks only run once when schedule triggers are documented on the same page Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…y/documentation-v2 into docs-new-messaging-and-agent-tasks
Summary by cubic
Restructures Get Started navigation, fixes broken links and AWS IAM policy drift, removes the header product switcher, and adds Agent Tasks (alpha) documentation.
Navigation & Docs
navigation.productswrapper fornavigation.tabs, eliminating the always-rendered header dropdown;docs/rde/**content stays untouched.docs.json, dissolves the Quickstart nav group, splits Installation into Local / Managed Cluster / BYOK, and renamesquickstart/docker-desktoptoquickstart/dockerwith a redirect.servicequotas:GetServiceQuota, removes duplicatedynamodb:*).aws.mdxon the same section skeleton as the other cloud providers, and extracts the Qovery CLI auth step into a shared snippet used by the Local and BYOK installs.qovery-onboardentry point andqovery-deployexecution steps.Agent Tasks (Alpha)
Written for commit 07cbebf. Summary will update on new commits.