Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-05-02#29649

Merged
pelikhan merged 1 commit intomainfrom
doc-healer/experiment-artifact-2026-05-02-4ccd437431054d25
May 2, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-05-02#29649
pelikhan merged 1 commit intomainfrom
doc-healer/experiment-artifact-2026-05-02-4ccd437431054d25

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 2, 2026

{
"title": "Self-healing documentation fixes from issue analysis - 2026-05-02",
"body": "### Self-Healing Documentation Fixes\n\nThis PR was automatically created by the Daily Documentation Healer workflow.\n\n### Gaps Fixed\n\n- experiment artifact missing from docs/src/content/docs/reference/artifacts.md — the ExperimentArtifactName constant (experiment) and its corresponding CLI artifact set (--artifacts experiment) were not documented anywhere in the Artifacts reference page.\n\n### Changes Made\n\n- Added experiment row to the Quick Reference table (constant, type, description)\n- Added experiment row to the Artifact Sets table (--artifacts experiment)\n- Added a new ## experiment section with contents, CLI usage example, and cross-reference to the A/B Experiments guide\n- Updated the multi-file artifact list in the Naming Compatibility prose to include experiment\n\n### Root Cause\n\nDDUw's artifact constant check scans pkg/constants/constants.go and pkg/constants/job_constants.go for ArtifactName constants and verifies each value appears in artifacts.md. The ExperimentArtifactName constant would be caught by this scan. However, DDUw has no equivalent check for ArtifactSet constants in pkg/cli/logs_artifact_set.go, so the experiment set name never appeared in the Artifact Sets table.\n\n

\nDDUw Improvement Suggestions\n\n### DDUw Improvement Suggestions\n\nAdd a second scan in DDUw Step 2 (Artifact constant check):\n\nbash\ngrep -Pn 'ArtifactSet\\w+\\s*ArtifactSet\\s*=' pkg/cli/logs_artifact_set.go\n\n\nFor each ArtifactSet constant found, verify that the set name value appears in the Artifact Sets table in docs/src/content/docs/reference/artifacts.md. If a set is missing, treat it as a documentation gap and add it.\n\nSuggested wording to add after the existing artifact constant check in DDUw Step 2:\n\n> Also run:\n> bash\n> grep -Pn 'ArtifactSet\\w+\\s*ArtifactSet\\s*=' pkg/cli/logs_artifact_set.go\n> \n> For each constant found, verify that the set name value is listed in the Artifact Sets table in docs/src/content/docs/reference/artifacts.md. If a set is missing from the table, treat it as a documentation gap and add it.\n\n
\n\n### Notes\n\nThe gh CLI was not available in this run (bash allowlist restricts gh to specific patterns). The experiment gap was identified via the local artifact constant check in Step 2 of the healer workflow.",
"branch": "doc-healer/experiment-artifact-2026-05-02",
"base": "main"
}

Generated by Daily Documentation Healer · ● 567.2K ·

  • expires on May 5, 2026, 12:08 AM UTC

The `experiment` artifact (`constants.ExperimentArtifactName = "experiment"`)
was missing from the Artifacts reference page. Add it to:
- Quick Reference table (with constant, type, and description)
- Artifact Sets table (`--artifacts experiment`)
- New `## experiment` section with contents, CLI usage, and cross-reference

Also include `experiment` in the multi-file artifact list in the
Naming Compatibility prose.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels May 2, 2026
@pelikhan pelikhan marked this pull request as ready for review May 2, 2026 00:14
Copilot AI review requested due to automatic review settings May 2, 2026 00:14
@pelikhan pelikhan merged commit 613b8ce into main May 2, 2026
@pelikhan pelikhan deleted the doc-healer/experiment-artifact-2026-05-02-4ccd437431054d25 branch May 2, 2026 00:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds missing documentation for the experiment artifact and the corresponding --artifacts experiment CLI artifact set in the Artifacts reference.

Changes:

  • Added experiment to the Quick Reference artifacts table (constant/type/description)
  • Added experiment to the Artifact Sets table and documented CLI usage
  • Added a dedicated ## experiment section and updated Naming Compatibility prose to mention experiment
Show a summary per file
File Description
docs/src/content/docs/reference/artifacts.md Documents the experiment artifact end-to-end (tables + dedicated section + compatibility note)

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 2

Comment on lines +185 to 186
Single-file artifacts are automatically flattened to root level regardless of their artifact directory name. Multi-file artifacts (`firewall-audit-logs`, `agent`, `activation`, `experiment`) retain their directory structure.

Comment on lines 35 to 36
| `firewall` | `firewall-audit-logs` | Network policy and firewall audit data |
| `mcp` | `firewall-audit-logs` | MCP gateway traffic logs |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants