Skip to content

docs: fix inaccuracies vs. Enterprise Server ground truth (Azure DevOps extension, etc.)#258

Merged
ryandens merged 6 commits into
mainfrom
worktree-fix-docs-ground-truth
Jun 24, 2026
Merged

docs: fix inaccuracies vs. Enterprise Server ground truth (Azure DevOps extension, etc.)#258
ryandens merged 6 commits into
mainfrom
worktree-fix-docs-ground-truth

Conversation

@ryandens

@ryandens ryandens commented Jun 24, 2026

Copy link
Copy Markdown
Member

Summary

PR #256 imported 71 pages from a marketing source (Pixee-Marketing-OS PR #117), introducing references to components Pixee does not have — the flagged example being an "Azure DevOps extension."

This PR was validated against charts/pixee-enterprise-server-docs (the Pixee Enterprise Server engineering docs). After review, the scope was narrowed to the high-confidence, agreed-upon factual corrections only; speculative rewrites were reverted (Grafana, BYOM provider list, observability, SonarQube auth, air-gap wording, etc. are unchanged from main).

yarn build passes clean (zero broken links) and yarn check-format (prettier) passes.

Changes in this PR

Area File(s) Correction
"Azure DevOps extension" getting-started/getting-started.md, faq/faq.md (×2) No such extension exists — Azure DevOps is a PAT + webhook integration. getting-started reworded to "Install the GitHub App — or a source control access token for GitLab, Bitbucket, or Azure DevOps"; faq mentions corrected to "integration."
GitLab token scopes getting-started/source-control.md, faq/faq.md Added the 3 missing scopes (ai_features, read_registry, read_virtual_registry) — 5 → 8, matching the GitLab Integration requirements.
Bitbucket token scopes getting-started/source-control.md Added the :bitbucket suffix to all 6 scopes, matching the BitBucket Cloud Integration requirements.
PostgreSQL version enterprise/deployment/helm.md "15+" → "17.4+" (per installation/prerequisites.md).
Universal SARIF page deleted integrations/sarif-universal.md; de-referenced in ci-cd.md, enterprise/troubleshooting.md, integrations/integrations-overview.md, api/sarif.md Removed the page and all links to it per review. The Universal SARIF capability is still described inline where it appeared.

Reverted after review (no longer in this PR)

Per reviewer direction, these were restored to their original main content: byom.md (provider list), enterprise-overview.md ("7 named tiers"), observability.md + deployment-overview.md (Grafana stack retained), platform/security.md (air-gap wording), integrations/scanners/sonarqube.md, and the ci-cd.md content edits (only the Universal SARIF reference was removed).

Still worth a look (not changed here)

A few other ground-truth discrepancies were found but left for a separate product decision: the PIXEE.yaml vs PIXEE.md config-file question, the scoped-API-token model in api/api-overview.md, the outbound-webhooks page (api/webhooks.md), a possible missing Black Duck page, and the Azure DevOps Server / Bitbucket Data Center support claims.

Test plan

  • yarn build clean — zero broken links (Universal SARIF page deletion verified)
  • yarn check-format (prettier) passes
  • GitLab/Bitbucket scope lists and PostgreSQL version verified against the Enterprise Server docs

🤖 Generated with Claude Code

…round truth

PR #256 imported 71 pages from a marketing source; several described
components or config Pixee does not have. Validated all new docs against
the Pixee Enterprise Server engineering docs (charts/pixee-enterprise-server-docs)
and corrected the high-confidence factual errors:

- "Azure DevOps extension" -> "Azure DevOps integration" (no such extension
  exists; ADO is a PAT + webhook integration). getting-started, faq.
- GitLab token scopes completed (added ai_features, read_registry,
  read_virtual_registry) and Bitbucket scopes given the :bitbucket suffix.
- PostgreSQL "15+" -> "17.4+".
- Observability: removed fabricated Grafana / "Grafana k8s-monitoring" /
  "Grafana Cloud Private Data Connector"; the real stack is
  VictoriaMetrics/VictoriaLogs/VictoriaTraces with VMUI dashboards.
- BYOM: removed unsupported providers (Google Vertex AI, Gemini, Nova,
  Mistral); reframed AWS Bedrock as the OpenAI-compatible path it is.
- "Hierarchical LLM routing (7 named tiers)" -> actual reasoning/fast/SCA/
  deep-research model slots.
- Air-gap: "Zero outbound internet after installation" -> outbound limited
  to (proxyable) license validation, matching the rest of the docs.
- SonarQube: removed invented "Browse and Administer" permissions; documented
  the required token scope + webhook secret.
- Universal SARIF / CI-CD: fixed the fabricated upload endpoint
  (api.pixee.ai/v1/sarif/upload) to the real multipart POST
  /api/v1/repositories/$REPO_ID/scans, and removed the nonexistent
  "Azure DevOps Code Scanning" surface.

yarn build passes clean (zero broken links).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Comment thread docs/enterprise/deployment/helm.md
Comment thread docs/enterprise/byom.md Outdated
Comment thread docs/enterprise/byom.md
Comment thread docs/enterprise/enterprise-overview.md
Comment thread docs/enterprise/observability.md Outdated
Comment thread docs/getting-started/getting-started.md Outdated
Comment thread docs/integrations/scanners/sonarqube.md
Comment thread docs/integrations/ci-cd.md
Comment thread docs/integrations/sarif-universal.md Outdated
Comment thread docs/platform/security.md Outdated
ryandens and others added 5 commits June 24, 2026 12:46
Restore original wording (Grafana retained) in byom, enterprise-overview,
observability, deployment-overview, security, and sonarqube per reviewer
request.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… table

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ryandens ryandens marked this pull request as ready for review June 24, 2026 19:48
@ryandens ryandens requested a review from dhafley June 24, 2026 19:48

@dhafley dhafley left a comment

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.

lgtm

@ryandens ryandens added this pull request to the merge queue Jun 24, 2026
Merged via the queue into main with commit 733a179 Jun 24, 2026
3 checks passed
@ryandens ryandens deleted the worktree-fix-docs-ground-truth branch June 24, 2026 20:06
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.

2 participants