Skip to content

docs: refonte Get Started navigation, retire AI Builder Portal, docum… - #186

Open
jul-dan wants to merge 9 commits into
mainfrom
docs-new-messaging-and-agent-tasks
Open

docs: refonte Get Started navigation, retire AI Builder Portal, docum…#186
jul-dan wants to merge 9 commits into
mainfrom
docs-new-messaging-and-agent-tasks

Conversation

@jul-dan

@jul-dan jul-dan commented Sep 10, 2026

Copy link
Copy Markdown
Contributor
  • 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

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

  • Removes AI Builder Portal from the product switcher and drops the navigation.products wrapper for navigation.tabs, eliminating the always-rendered header dropdown; docs/rde/** content stays untouched.
  • Dedupes pages listed twice in docs.json, dissolves the Quickstart nav group, splits Installation into Local / Managed Cluster / BYOK, and renames quickstart/docker-desktop to quickstart/docker with a redirect.
  • Fixes the repo-wide missing-prefix link bug, and fixes AWS IAM policy drift in the credential snippets and downloadable JSON (adds servicequotas:GetServiceQuota, removes duplicate dynamodb:*).
  • Converts AWS, Azure, and Scaleway guides to import credential snippets instead of duplicating them, rebuilds aws.mdx on 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.
  • Strips marketing language, emojis, and em dashes, realigns intro/how-it-works messaging with qovery.com, surfaces the Migrate to Kubernetes card first, and splits migration duties between the qovery-onboard entry point and qovery-deploy execution steps.

Agent Tasks (Alpha)

  • Adds a Getting Started overview with the two ready-made templates and a Configuration reference covering setup, resources, governance, and environment variables.
  • Moves Agent Tasks into its own Services group with the two template guides nested under an Examples subgroup so more can be added later.
  • Documents automations (schedule and webhook triggers, webhook outputs); the Incident Analyser and Build & Deployment Optimizer guides describe behavior and setup instead of literal prompt text and exact resource values.
  • Qovery's own MCP server is not added automatically; docs note it must be added manually and that org-level MCP servers can scope agent access via API Policy Tokens.

Written for commit 07cbebf. Summary will update on new commits.

Review in cubic

…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>
@jul-dan
jul-dan requested a review from a team September 10, 2026 09:42
@mintlify

mintlify Bot commented Sep 10, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
qovery 🟢 Ready View Preview Sep 10, 2026, 3:04 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 10, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

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>
Comment thread docs/docs.json Outdated
Comment thread docs/docs.json Outdated
Comment thread docs/configuration/agent-tasks/incident-analyser.mdx Outdated
Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/getting-started/introduction.mdx
Comment thread docs/configuration/agent-tasks/incident-analyser.mdx Outdated
Comment thread docs/snippets/aws-credentials-static.mdx
Comment thread docs/snippets/README.md
Comment thread docs/getting-started/guides/use-cases/cloud-migration-and-scaling.mdx Outdated
Comment thread docs/getting-started/how-it-works.mdx
Comment thread docs/snippets/README.md
Comment thread docs/getting-started/guides/use-cases/cloud-migration-and-scaling.mdx Outdated
Comment thread docs/snippets/README.md
Comment thread docs/getting-started/agent-tasks.mdx Outdated
<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">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we make it more visible the Migration use case?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw, the migration use case should be the first in every list. Before the "Deploy with AI Agent"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is that true?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which part :) ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Qovery's own MCP server is available by default in read-only mode.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought that this MCP was added automatically

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx Outdated
jul-dan and others added 3 commits September 10, 2026 13:42
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>
Comment thread docs/configuration/agent-tasks/overview.mdx
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
jul-dan and others added 2 commits September 10, 2026 17:01
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants