Skip to content

Commit 0c0b51f

Browse files
dhafleyclaude
andcommitted
docs: archive migration tooling and assessment doc
Adds migration/ at the repo root as a historical record of the 2026-05-05 docs redesign. Contents: - ASSESSMENT.md — planning and decision log, including the three-repo deploy flow, redirect table, SEO additions, and what was actually executed. - migrate.py — one-shot Python script that ported PR #117 content into docs/docs/, normalized frontmatter, dropped numeric prefixes, generated _category_.json files. - fixup_links.py — one-shot link-fixup pass that fixed 27 internal markdown links across 9 files after migrate.py. - README.md — orientation for future readers, plus a clear DO-NOT-RE-RUN warning (migrate.py would wipe the manually-authored Contrast page and revert the welcome doc's slug: /). Lives at the repo root rather than docs/migration/ so Docusaurus does not treat these files as published pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f4a18e4 commit 0c0b51f

77 files changed

Lines changed: 1895 additions & 1648 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api/api-overview.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -58,29 +58,29 @@ repositories = response.json()
5858

5959
## Rate limits
6060

61-
| Tier | Requests per minute | Burst |
62-
|------|-------------------|-------|
63-
| Standard | 60 | 10 |
64-
| Enterprise | 300 | 50 |
61+
| Tier | Requests per minute | Burst |
62+
| ---------- | ------------------- | ----- |
63+
| Standard | 60 | 10 |
64+
| Enterprise | 300 | 50 |
6565

6666
Rate-limited responses return `429 Too Many Requests` with a `Retry-After` header indicating seconds until the next available request window.
6767

6868
## Available endpoints
6969

70-
| Category | Method | Endpoint | Description |
71-
|----------|--------|----------|-------------|
72-
| Repositories | `GET` | `/repositories` | List repositories connected to your organization |
73-
| Repositories | `GET` | `/repositories/{id}` | Get repository configuration and status |
74-
| Repositories | `PATCH` | `/repositories/{id}` | Update repository settings |
75-
| Fixes | `GET` | `/repositories/{id}/fixes` | List fix results for a repository |
76-
| Fixes | `GET` | `/fixes/{id}` | Get fix details including CodeTF output |
77-
| Scans | `GET` | `/repositories/{id}/scans` | List scan history |
78-
| Scans | `POST` | `/repositories/{id}/scans` | Trigger a new scan |
79-
| Triage | `GET` | `/repositories/{id}/findings` | List triaged findings |
80-
| Triage | `GET` | `/findings/{id}` | Get finding details and triage classification |
81-
| Webhooks | `POST` | `/webhooks` | Register a webhook endpoint |
82-
| Webhooks | `GET` | `/webhooks` | List registered webhooks |
83-
| Webhooks | `DELETE` | `/webhooks/{id}` | Remove a webhook |
70+
| Category | Method | Endpoint | Description |
71+
| ------------ | -------- | ----------------------------- | ------------------------------------------------ |
72+
| Repositories | `GET` | `/repositories` | List repositories connected to your organization |
73+
| Repositories | `GET` | `/repositories/{id}` | Get repository configuration and status |
74+
| Repositories | `PATCH` | `/repositories/{id}` | Update repository settings |
75+
| Fixes | `GET` | `/repositories/{id}/fixes` | List fix results for a repository |
76+
| Fixes | `GET` | `/fixes/{id}` | Get fix details including CodeTF output |
77+
| Scans | `GET` | `/repositories/{id}/scans` | List scan history |
78+
| Scans | `POST` | `/repositories/{id}/scans` | Trigger a new scan |
79+
| Triage | `GET` | `/repositories/{id}/findings` | List triaged findings |
80+
| Triage | `GET` | `/findings/{id}` | Get finding details and triage classification |
81+
| Webhooks | `POST` | `/webhooks` | Register a webhook endpoint |
82+
| Webhooks | `GET` | `/webhooks` | List registered webhooks |
83+
| Webhooks | `DELETE` | `/webhooks/{id}` | Remove a webhook |
8484

8585
For webhook event types and payload schemas, see [Webhooks](/api/webhooks).
8686

@@ -98,14 +98,14 @@ All error responses use a consistent JSON structure:
9898
}
9999
```
100100

101-
| Status code | Meaning |
102-
|-------------|---------|
103-
| `400` | Bad request. Check request body and parameters. |
104-
| `401` | Invalid or missing API token. |
105-
| `403` | Token does not have permission for this resource. |
106-
| `404` | Resource not found. |
107-
| `429` | Rate limit exceeded. Retry after the interval in the `Retry-After` header. |
108-
| `500` | Internal server error. Retry with exponential backoff. Include the `request_id` in support tickets. |
101+
| Status code | Meaning |
102+
| ----------- | --------------------------------------------------------------------------------------------------- |
103+
| `400` | Bad request. Check request body and parameters. |
104+
| `401` | Invalid or missing API token. |
105+
| `403` | Token does not have permission for this resource. |
106+
| `404` | Resource not found. |
107+
| `429` | Rate limit exceeded. Retry after the interval in the `Retry-After` header. |
108+
| `500` | Internal server error. Retry with exponential backoff. Include the `request_id` in support tickets. |
109109

110110
## Quick start
111111

docs/api/changelog.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,12 @@ Categories are omitted when a release has no entries of that type.
123123

124124
Pixee Enterprise Server releases are versioned independently of the Pixee cloud platform. The Helm chart version (e.g., v5.6.0) and embedded cluster version share the same release notes.
125125

126-
| Deployment Model | Version Source | Update Method |
127-
|-----------------|---------------|---------------|
128-
| Cloud (SaaS) | Automatic | Managed by Pixee |
129-
| Embedded Cluster | KOTS admin console | One-click update via admin console |
126+
| Deployment Model | Version Source | Update Method |
127+
| --------------------- | ------------------ | ------------------------------------- |
128+
| Cloud (SaaS) | Automatic | Managed by Pixee |
129+
| Embedded Cluster | KOTS admin console | One-click update via admin console |
130130
| Helm / BYO Kubernetes | Helm chart version | `helm upgrade` with new chart version |
131-
| Air-gapped | Offline bundle | Download bundle, apply via KOTS |
131+
| Air-gapped | Offline bundle | Download bundle, apply via KOTS |
132132

133133
For upgrade procedures and troubleshooting, see [Enterprise Deployment](/enterprise/deployment) and [Enterprise Troubleshooting](/enterprise/troubleshooting).
134134

docs/api/codetf.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,22 @@ CodeTF (Code Transformation Format) is an open specification created by Pixee fo
1414

1515
## What is CodeTF?
1616

17-
Existing standards describe security findings (SARIF), dependencies (SBOM), and vulnerabilities (CVE/CWE). No standard existed for describing *what an automated fix actually did to your code*. CodeTF fills that gap.
17+
Existing standards describe security findings (SARIF), dependencies (SBOM), and vulnerabilities (CVE/CWE). No standard existed for describing _what an automated fix actually did to your code_. CodeTF fills that gap.
1818

1919
CodeTF is the output format. SARIF is the input format. A scanner produces a SARIF file describing the problem. Pixee consumes that SARIF, generates a fix, and produces a CodeTF document describing the solution.
2020

2121
CodeTF is an open specification. Any tool can produce or consume CodeTF documents. The schema is publicly available on [GitHub](https://github.com/pixee/codemodder-specs).
2222

2323
## CodeTF vs SARIF
2424

25-
| Dimension | SARIF | CodeTF |
26-
|-----------|-------|--------|
27-
| Purpose | Describes findings (problems) | Describes fixes (changes) |
28-
| Direction | Scanner output | Remediation output |
29-
| Content | Vulnerability location and metadata | Code diffs, rationale, and validation |
30-
| Standard body | OASIS | Open specification by Pixee |
31-
| Use case | Input to Pixee | Output from Pixee |
32-
| Data model | Runs, results, locations | Run metadata, results, changesets |
25+
| Dimension | SARIF | CodeTF |
26+
| ------------- | ----------------------------------- | ------------------------------------- |
27+
| Purpose | Describes findings (problems) | Describes fixes (changes) |
28+
| Direction | Scanner output | Remediation output |
29+
| Content | Vulnerability location and metadata | Code diffs, rationale, and validation |
30+
| Standard body | OASIS | Open specification by Pixee |
31+
| Use case | Input to Pixee | Output from Pixee |
32+
| Data model | Runs, results, locations | Run metadata, results, changesets |
3333

3434
## Schema overview
3535

@@ -65,50 +65,50 @@ CodeTF Document
6565

6666
### Top-level fields
6767

68-
| Field | Type | Required | Description |
69-
|-------|------|----------|-------------|
70-
| `version` | string | Yes | Schema version. Current: `"3.0.0"` |
71-
| `run` | object | Yes | Execution context for the transformation run |
72-
| `results` | array | Yes | Array of transformation results. May be empty if no fixes were generated. |
68+
| Field | Type | Required | Description |
69+
| --------- | ------ | -------- | ------------------------------------------------------------------------- |
70+
| `version` | string | Yes | Schema version. Current: `"3.0.0"` |
71+
| `run` | object | Yes | Execution context for the transformation run |
72+
| `results` | array | Yes | Array of transformation results. May be empty if no fixes were generated. |
7373

7474
### Run object
7575

76-
| Field | Type | Required | Description |
77-
|-------|------|----------|-------------|
78-
| `run.vendor` | string | Yes | Vendor name (e.g., `"pixee"`) |
79-
| `run.tool` | string | Yes | Engine identifier (e.g., `"codemodder-python"`) |
80-
| `run.elapsed` | string | No | ISO 8601 duration or human-readable processing time |
81-
| `run.commandLine` | string | No | Command used to invoke the transformation |
76+
| Field | Type | Required | Description |
77+
| ----------------- | ------ | -------- | --------------------------------------------------- |
78+
| `run.vendor` | string | Yes | Vendor name (e.g., `"pixee"`) |
79+
| `run.tool` | string | Yes | Engine identifier (e.g., `"codemodder-python"`) |
80+
| `run.elapsed` | string | No | ISO 8601 duration or human-readable processing time |
81+
| `run.commandLine` | string | No | Command used to invoke the transformation |
8282

8383
### Result object
8484

85-
| Field | Type | Required | Description |
86-
|-------|------|----------|-------------|
87-
| `codemod` | string | Yes | Unique codemod identifier (e.g., `"pixee:python/secure-random"`) |
88-
| `summary` | string | Yes | One-line human-readable fix description |
89-
| `description` | string | Yes | Detailed explanation of what the fix does and why |
90-
| `references` | array | No | External references: `{"url": "https://cwe.mitre.org/...", "description": "CWE-330"}` |
91-
| `properties` | object | No | Arbitrary key-value metadata for custom integrations |
92-
| `changeset` | array | Yes | Array of file-level changes (at least one entry per result) |
93-
| `detectionTool` | string | No | Scanner that detected the original finding |
94-
| `fixedFindings` | array | No | Array of SARIF finding references this fix resolves |
85+
| Field | Type | Required | Description |
86+
| --------------- | ------ | -------- | ------------------------------------------------------------------------------------- |
87+
| `codemod` | string | Yes | Unique codemod identifier (e.g., `"pixee:python/secure-random"`) |
88+
| `summary` | string | Yes | One-line human-readable fix description |
89+
| `description` | string | Yes | Detailed explanation of what the fix does and why |
90+
| `references` | array | No | External references: `{"url": "https://cwe.mitre.org/...", "description": "CWE-330"}` |
91+
| `properties` | object | No | Arbitrary key-value metadata for custom integrations |
92+
| `changeset` | array | Yes | Array of file-level changes (at least one entry per result) |
93+
| `detectionTool` | string | No | Scanner that detected the original finding |
94+
| `fixedFindings` | array | No | Array of SARIF finding references this fix resolves |
9595

9696
### Changeset object
9797

98-
| Field | Type | Required | Description |
99-
|-------|------|----------|-------------|
100-
| `path` | string | Yes | File path relative to repository root |
101-
| `diff` | string | Yes | Unified diff of the change |
102-
| `changes` | array | No | Line-level descriptions of individual changes |
103-
| `ai` | boolean | No | `true` if AI generated this change; `false` or absent for deterministic codemods |
98+
| Field | Type | Required | Description |
99+
| --------- | ------- | -------- | -------------------------------------------------------------------------------- |
100+
| `path` | string | Yes | File path relative to repository root |
101+
| `diff` | string | Yes | Unified diff of the change |
102+
| `changes` | array | No | Line-level descriptions of individual changes |
103+
| `ai` | boolean | No | `true` if AI generated this change; `false` or absent for deterministic codemods |
104104

105105
### Change object
106106

107-
| Field | Type | Required | Description |
108-
|-------|------|----------|-------------|
109-
| `lineNumber` | integer | Yes | Line number in the modified file |
110-
| `description` | string | Yes | What changed at this line |
111-
| `properties` | object | No | Additional per-change metadata |
107+
| Field | Type | Required | Description |
108+
| ------------- | ------- | -------- | -------------------------------- |
109+
| `lineNumber` | integer | Yes | Line number in the modified file |
110+
| `description` | string | Yes | What changed at this line |
111+
| `properties` | object | No | Additional per-change metadata |
112112

113113
## Complete example
114114

@@ -220,10 +220,10 @@ with open("audit-trail.csv", "w", newline="") as f:
220220

221221
CodeTF uses semantic versioning. The current schema version is `3.0.0`.
222222

223-
| Version | Status | Notes |
224-
|---------|--------|-------|
225-
| 3.0.0 | Current | Pydantic-modeled schema, fix-quality ratings, package actions |
226-
| 2.0.0 | Supported | Previous schema version |
223+
| Version | Status | Notes |
224+
| ------- | --------- | ------------------------------------------------------------- |
225+
| 3.0.0 | Current | Pydantic-modeled schema, fix-quality ratings, package actions |
226+
| 2.0.0 | Supported | Previous schema version |
227227

228228
Breaking changes between major versions are documented in the [Changelog](/api/changelog). CodeTF documents always include a `version` field so consumers can branch on schema version at parse time.
229229

0 commit comments

Comments
 (0)