Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ RUN apt-get update && apt-get install -y \
linux-headers-generic \
kmod \
git \
gh \
vim \
sudo \
curl \
Expand Down
7 changes: 7 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ per-process I/O statistics, ELF metadata, and thread information.
- `docs/CODE_QUALITY.md`: quality tooling details
- `docs/SCRIPTS.md`: QEMU workflow details
- `docs/RELEASE.md`: release process and labels
- `docs/AGENTIC_WORKFLOW.md`: high-level docs-agent workflow guide

### Agentic Workflow Source of Truth

- Author workflow logic in `.github/workflows/update-docs-agent.md`
- Treat `.github/workflows/update-docs-agent.lock.yml` as generated output
- Recompile after edits with `gh aw compile update-docs-agent`

## Code Style and Standards

Expand Down
70 changes: 44 additions & 26 deletions .github/workflows/update-docs-agent.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 9 additions & 6 deletions .github/workflows/update-docs-agent.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
---
description: |
Keeps ProcLens documentation synchronized with kernel/userspace/release changes.
Triggered on pushes to main/master and manual dispatch. It analyzes diffs in src/,
Triggered on pull request closure targeting main and manual dispatch. It analyzes diffs in src/,
e2e/, Makefile, and .github/workflows, then updates matching documentation while
preserving the project's style and single-source-of-truth rules.

on:
push:
branches: [main, master]
pull_request:
branches: [main]
types: [closed]
workflow_dispatch:

if: github.actor != 'github-actions[bot]'

permissions: read-all

network: defaults

safe-outputs:
create-pull-request:
draft: true
draft: false
protected-files: fallback-to-issue
labels: [automation, documentation]

Expand All @@ -38,7 +41,7 @@ Your name is ${{ github.workflow }}. You are an Autonomous Technical Writer and
### Mission

Keep ProcLens docs aligned with code behavior for both kernel module and userspace CLI paths.
Treat documentation drift as a failing quality signal and fix it through focused draft pull requests.
Treat documentation drift as a failing quality signal and fix it through focused pull requests.

### Project-Specific Ground Truth

Expand Down Expand Up @@ -102,7 +105,7 @@ Treat documentation drift as a failing quality signal and fix it through focused

5. Produce safe output

- Create a draft pull request with:
- Create a pull request with:
- concise summary of detected code-to-doc mappings
- list of modified docs and why each changed
- explicit note if no doc update was needed
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,7 @@ Code formatter that ensures consistent style:
- [CODE_QUALITY.md](docs/CODE_QUALITY.md) - Static analysis, code formatting, best practices
- [SCRIPTS.md](docs/SCRIPTS.md) - Detailed script documentation
- [RELEASE.md](docs/RELEASE.md) - Version release process and guidelines
- [AGENTIC_WORKFLOW.md](docs/AGENTIC_WORKFLOW.md) - High-level guide for the docs agent workflow

## Contributing

Expand Down
Loading
Loading