diff --git a/docs/contributing.mdx b/docs/contributing.mdx index ad759ea3..fc327614 100644 --- a/docs/contributing.mdx +++ b/docs/contributing.mdx @@ -61,11 +61,11 @@ Skills are specialized knowledge packages that enhance agent capabilities. They ### Pull Request Process 1. **Create an issue first:** Describe the problem or feature -2. **Fork and branch:** Create a branch from `main` -3. **Make changes:** Follow the existing code style -4. **Write tests:** Add coverage for new features +2. **Fork and branch:** Work from `main` +3. **Make changes:** Follow existing code style +4. **Write tests:** Ensure coverage for new features 5. **Run checks:** `make check-all` should pass -6. **Submit a pull request:** Link to the issue and provide context +6. **Submit a pull request:** Link to issue and provide context ### Code Style diff --git a/docs/index.mdx b/docs/index.mdx index a74417c2..d368abf9 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -40,7 +40,7 @@ Strix agents are autonomous and act like real hackers. They run your code dynami ## Security Tools -Strix agents include a comprehensive toolkit: +Strix agents come equipped with a comprehensive toolkit: | Tool | Purpose | |------|---------| diff --git a/docs/integrations/ci-cd.mdx b/docs/integrations/ci-cd.mdx index 4ce67049..f55ebc16 100644 --- a/docs/integrations/ci-cd.mdx +++ b/docs/integrations/ci-cd.mdx @@ -82,9 +82,9 @@ jobs: ``` -All CI platforms require Docker access. Your runner must have Docker available. +All CI platforms require Docker access. Ensure your runner has Docker available. - -If diff-scope fails in CI, full git history is required for merge-base and branch comparison. In GitHub Actions, use `fetch-depth: 0`. - + +If diff-scope fails in CI, fetch full git history (for example, `fetch-depth: 0` in GitHub Actions) so merge-base and branch comparison can be resolved. + diff --git a/docs/integrations/coding-agents.mdx b/docs/integrations/coding-agents.mdx index 30167e88..f4c74cc0 100644 --- a/docs/integrations/coding-agents.mdx +++ b/docs/integrations/coding-agents.mdx @@ -15,8 +15,8 @@ npx skills add usestrix/strix | Skill | What your agent learns | |-------|------------------------| -| `penetration-testing-with-strix` | Run headless scans against code, URLs, domains, or IPs: self-hosted CLI or managed cloud: with budget caps, and read the results | -| `managed-pentesting-with-strix` | Drive the managed [app.strix.ai](https://app.strix.ai) platform over REST: no local Docker or LLM key needed | +| `penetration-testing-with-strix` | Run headless scans against code, URLs, domains, or IPs with the self-hosted CLI or the managed cloud, apply budget caps, and read the results | +| `managed-pentesting-with-strix` | Drive the managed [app.strix.ai](https://app.strix.ai) platform over REST. No local Docker or LLM key needed | | `fix-security-vulnerabilities-with-strix` | Triage findings, fix root causes, and re-run Strix to verify each fix | | `ci-security-scanning-with-strix` | Add PR security scanning to GitHub Actions or any CI (self-hosted CLI or managed app) | @@ -30,10 +30,10 @@ npx skills use usestrix/strix@penetration-testing-with-strix | claude Both use the same engine and produce the same validated findings and SARIF. Agents can pick per situation or combine them. -- **Open-source CLI (self-hosted):** Runs locally in a Docker sandbox with your LLM key. It is free, fully local, and air-gap capable. It suits local development loops and full control. -- **Managed cloud:** Runs on Strix infrastructure through the [app.strix.ai REST API](https://docs.app.strix.ai). It needs no Docker, LLM key, or local installation. The Enterprise plan adds dashboards, scheduling, pull request reviews, and PDF or DOCX reports. It suits sandboxed or CI environments and teams. +- **Open-source CLI (self-hosted):** Runs locally in a Docker sandbox with your own LLM key. It is free, fully local, and air-gap capable. It suits local development loops and full control. +- **Managed cloud:** Runs on Strix infrastructure through the [app.strix.ai REST API](https://docs.app.strix.ai). It needs no Docker, LLM key, or local installation. The Enterprise plan adds team dashboards, scheduling, pull request reviews, and downloadable PDF or DOCX reports. It suits sandboxed or CI environments and teams. -Create a managed API token under **Settings > API Access**. The `managed-pentesting-with-strix` skill documents the full flow. +Create a managed API token under **Settings → API Access**. The `managed-pentesting-with-strix` skill documents the full flow. ## Agent-Friendly Interfaces diff --git a/docs/tools/browser.mdx b/docs/tools/browser.mdx index e337e699..21dc73a0 100644 --- a/docs/tools/browser.mdx +++ b/docs/tools/browser.mdx @@ -3,7 +3,7 @@ title: "Browser" description: "Playwright-powered Chrome for web application testing" --- -Strix uses a headless Chrome browser through Playwright to interact with web applications in the same way as a real user. +Strix uses a headless Chrome browser through Playwright to interact with web applications exactly like a real user would. ## How It Works