Repository navigation
docs: add a scheduled whitebox scans guide - #110
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c00f7d282b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <Step title="Set up the scan for each environment"> | ||
| On the **Environments** tab, each environment now has **Set up scan** in place of the branch picker. Select it to open the environment's scan settings. They reuse the steps of the [Whitebox Scans wizard](/white-box-pentest/quickstart), with **Scan options** in place of the cost calculation and checkout: |
There was a problem hiding this comment.
When a reader follows the newly documented scheduled flow, this step introduces Set up scan, six wizard pages, Save scan settings, and the required per-environment state, but none of the added images shows that UI; the only Environments image above shows the branch picker used for finding-triggered automations. Add a current screenshot, or a capture-blocked caveat, for this configuration path so readers do not have to guess through the central new workflow.
AGENTS.md reference: AGENTS.md:L6-L8
Useful? React with 👍 / 👎.
zeyu2001
changed the title
Adds a dedicated Scheduled whitebox scans guide beside Remediation in the Automations navigation. The Automations overview introduces scheduling and links its trigger, scan action, environment scan settings, execution history, and related-docs card to the full guide. The guide links back to the overview.
The guide covers daily, weekly, monthly, and custom cron schedules, timezones, per-environment scan settings, login checks, enabling schedules, credit limits, skipped runs, and execution history. Whitebox quickstart, billing, and automation-credit links point directly to it. The overview keeps a short
#scheduled-whitebox-scanssection for existing links.Content comes from landing #225 at
4f71ed506ce32ed74ea67029a0e89ce0b681cddb, with Mintlify components and docs-site routes. Product labels and key schedule, credit, and concurrency behavior were checked against web1296a5739. Five light/dark product-shots captures are reused across the overview and guide. They show the actual frontend with sanitized mock data.Validation:
pnpm lint,pnpm exec mintlify broken-links,pnpm exec mintlify validate --telemetry false,git diff --check, and the normal GitGuardian commit hook.Browser evidence: Chrome at 1440×1100 and 390×844; the new sidebar entry is active and sits between Remediation and Automation credits; three setup steps and two tables render on the new page; the correct screenshot loads in each theme; the mobile document width equals its 390px viewport. All nine overview links to the guide resolve, including setup/history anchors. Clicking Start whitebox scan opens the guide. Quickstart, billing, and automation-credit references return HTTP 200 and point to the new route. The run-history anchor lands below the fixed header, and the guide links back to the overview.
These checks cover rendered documentation. They do not launch product scans.
Note
Low Risk
Documentation and navigation only; no application or billing logic changes.
Overview
Adds scheduled whitebox scans to the docs site: a new
platform/automations/scheduled-whitebox-scanspage (ported from landing), linked from Automations nav indocs.json.The Automations overview is expanded so automations can trigger on New vulnerability found (Apply Remediation) or On a schedule (Start whitebox scan), with updated step-by-step UI copy, settings tables, light/dark screenshots, and run-history notes for scheduled runs.
Automation credits now states remediation uses automation credits while scheduled scans draw Whitebox Scan credits. Whitebox billing and quickstart link scheduled scans and describe per-run estimates, credit caps, and Needs attention when a run can't start.
Reviewed by Cursor Bugbot for commit 018b04b. Bugbot is set up for automated code reviews on this repo. Configure here.