Skip to content

docs: refresh project documentation inventory #3590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcusrbrown merged 1 commit into from
Jun 26, 2026
Merged

docs: refresh project documentation inventory #3590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions .agents/skills/generating-project-docs/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Before writing anything, gather these from the live repo:
| `package.json` | name, description, scripts, packageManager (pnpm version), engines, repository |
| `README.md` (current) | banner, badges, navigation, section order, voice |
| `.github/workflows/` | workflow names, triggers, purposes (read each `name:` and top-level `on:` block) |
| `scripts/*.ts` | TypeScript entrypoints, exported functions, test counts (`pnpm test --reporter=basic`) |
| `scripts/*.ts` | TypeScript entrypoints, exported functions, test summary (`pnpm test`) |
| `metadata/*.yaml` | metadata files in scope and their schemas |
| `knowledge/{schema,index,log}.md` + `knowledge/wiki/` | wiki coverage stats (counts of repos/topics/entities) |
| `persona/`, `branding/`, `assets/` | character + brand asset inventory |
Expand Down Expand Up @@ -101,7 +101,7 @@ For section-scoped updates: read the current document, locate the section by hea

**Accuracy (always):**

- Every count matches the inventory (`ls`, `find`, `pnpm test` output)
- Every count matches the inventory (`ls`, `find`, `pnpm test` output — do not pipe or truncate test output)
- Every workflow listed has a real `.github/workflows/*.yaml` file
- Every script listed has a real `scripts/*.ts` file
- Every link resolves (relative paths exist, external URLs are correct)
Expand Down Expand Up @@ -134,7 +134,7 @@ For section-scoped updates: read the current document, locate the section by hea
ls .github/workflows/ # workflow count + names
ls scripts/*.ts | grep -v test # production script count
ls scripts/*.test.ts # test file count
pnpm test --reporter=basic 2>&1 | tail -5 # actual test count
pnpm test # test summary (do not pipe or truncate)
ls metadata/*.yaml # metadata file count
find knowledge/wiki -name '*.md' | wc -l # wiki page count
git log --oneline -15 # recent change context
Expand Down
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ This repository provides shared configurations and automation for the Fro Bot ec
### Prerequisites

- **Node.js** 24 (pinned in [`mise.toml`](mise.toml); native TypeScript execution, no build step)
- **pnpm** 11.6.0 (pinned in `packageManager`)
- **pnpm** 11.8.0 (pinned in `packageManager`)
- **Git** for version control
- Optional: [`mise`](https://mise.jdx.dev/) to auto-install the pinned toolchain

Expand Down Expand Up @@ -150,7 +150,7 @@ This repository provides shared configurations and automation for the Fro Bot ec
├── .github/ # GitHub-specific configurations
│ ├── actions/setup/ # Composite bootstrap action
│ ├── hooks/ # Copilot governance hooks
│ ├── workflows/ # 21 GitHub Actions workflows (see Automation)
│ ├── workflows/ # 23 GitHub Actions workflows (see Automation)
│ ├── copilot-instructions.md # Canonical AI-assistant guidance
│ ├── renovate.json5 # Dependency management config
│ └── settings.yml # Repository settings via Probot
Expand Down Expand Up @@ -194,29 +194,31 @@ This repository provides shared configurations and automation for the Fro Bot ec

Quality gates:

| Workflow | Purpose | Trigger |
| ----------------------- | ------------------------------------------------------- | -------------------------- |
| **Main** | Lint, type checking, tests, workflow validation, CodeQL | PR, push to main, dispatch |
| **CodeQL** | Security vulnerability analysis | PR, push to main, weekly |
| **Dependency Review** | Block PRs introducing known-vulnerable packages | Pull request |
| **Scorecard** | OpenSSF supply-chain security posture | Push to main, weekly |
| **Copilot Setup Steps** | Environment bootstrap for GitHub Copilot coding agent | PR/push touching the file |
| Workflow | Purpose | Trigger |
| --- | --- | --- |
| **Main** | Lint, type checking, tests, and workflow validation | PR, push to main, dispatch |
| **CodeQL** | Security vulnerability analysis | PR, push to main, weekly |
| **Dependency Review** | Block PRs introducing known-vulnerable packages | Pull request |
| **Scorecard supply-chain security** | OpenSSF supply-chain security posture | Push to main, weekly |
| **Copilot Setup Steps** | Environment bootstrap for GitHub Copilot coding agent | PR/push touching the file |
| **Check Private Leak** | Triggered follow-up on private-leak sentinel findings | Workflow run |
| **Private Leak Sentinel** | Scan PRs for accidental private-data exposure | Pull request |

Fro Bot control plane:

| Workflow | Purpose | Trigger |
| --- | --- | --- |
| **Fro Bot** | Core agent: PR review, issue triage, scheduled oversight, manual tasks | Issues, PR events, schedule, dispatch |
| **Fro Bot Autoheal** | Scheduled self-repair pass | Daily 03:30 UTC, dispatch |
| **Fro Bot** | Core agent: PR review, issue triage, scheduled oversight, manual tasks | Issues, PR events, schedule, dispatch, workflow_call |
| **Capture Learnings** | Capture and commit knowledge-wiki learnings to the `data` branch | Schedule, dispatch |
| **Poll Invitations** | Accept allowlisted collaboration invitations | Every 15 minutes, dispatch |
| **Reconcile Repos** | Reconcile collaborator access against `metadata/repos.yaml`; dispatch surveys for stale repos; auto-stars collab/contrib repos | Daily 05:17 UTC, dispatch |
| **Survey Repo** | Ingest a repository into the knowledge wiki; dispatched by Reconcile Repos or manually via `gh workflow run survey-repo.yaml -f node_id=<node_id>` | Dispatch (by Reconcile Repos) |
| **Merge Data Branch** | Promote autonomous `data`-branch commits to `main` | Sunday 22:00 UTC, dispatch |
| **Update Metadata** | Refresh `metadata/renovate.yaml` from the fro-bot org scan | Daily 04:30 UTC, dispatch |
| **Dispatch Renovate** | Dispatch Renovate runs across repos tracked in `metadata/renovate.yaml` | Every 4 hours at `:30`, dispatch |
| **Gateway Rollout Tracker** | Track and report on gateway rollout status across managed repos | Schedule, dispatch |
| **Reset Survey Status** | Manually clear stale survey state for one or more tracked repos on `data` | Manual dispatch |
| **Wiki Lint** | Lint the authoritative wiki snapshot restored from `origin/data` | Sunday 20:00 UTC, dispatch |
| **Social Broadcast** | Reusable Discord, Bluesky, and journal fan-out for Fro Bot events | Reusable `workflow_call` |

Repository management:

Expand Down
Loading