mirror of https://github.com/affaan-m/ECC.git synced 2026-09-30 21:45:13 +02:00

Files

T

Affaan MustafaandGitHub c70874fae9 feat(pi): curated pi/core skills+prompts profile, CI load test, and 2.2.2 release sync (#3264 )

Adds a curated, Pi-native, skills+prompts-only profile at pi/core/ for downstream packagers that mirror GitHub Releases.

- manifests/pi-core.json: explicit include lists, per-item exclusion reasons, curation rules, safety allowlists; every root skill and command must be classified.
- scripts/build-pi-core.js regenerates pi/core deterministically (package.json from VERSION, LICENSE, README.md, CURATION.md, skills/, commands/); --check fails CI on drift. council is renamed ecc-council inside pi/core only.
- Safety checks: no callable endpoints outside the allowlist, no npx/curl|sh/pip install, no secrets, no absolute home paths, no symlinks, valid frontmatter, no duplicate names.
- CI: build + drift check and an offline Pi CLI load test of pi/core.
- Release: VERSION, package.json and pi/core/package.json at 2.2.2, CHANGELOG, tag-triggered release verification, and a two-week cadence in CONTRIBUTING.md.

pi/core: 123 of 293 skills and 24 of 94 commands; 35,006 characters of skill description text.

2026-09-29 20:24:05 -05:00

3.0 KiB

Raw Blame History

description

description
Sync documentation from source-of-truth files such as scripts, schemas, routes, and exports.

Update Documentation

Sync documentation with the codebase, generating from source-of-truth files.

Step 1: Identify Sources of Truth

Source	Generates
`package.json` scripts	Available commands reference
`.env.example`	Environment variable documentation
`openapi.yaml` / route files	API endpoint reference
Source code exports	Public API documentation
`Dockerfile` / `docker-compose.yml`	Infrastructure setup docs

Step 2: Generate Script Reference

Read package.json (or Makefile, Cargo.toml, pyproject.toml)
Extract all scripts/commands with their descriptions
Generate a reference table:

| Command | Description |
|---------|-------------|
| `npm run dev` | Start development server with hot reload |
| `npm run build` | Production build with type checking |
| `npm test` | Run test suite with coverage |

Step 3: Generate Environment Documentation

Read .env.example (or .env.template, .env.sample)
Extract all variables with their purposes
Categorize as required vs optional
Document expected format and valid values

| Variable | Required | Description | Example |
|----------|----------|-------------|---------|
| `DATABASE_URL` | Yes | PostgreSQL connection string | `postgres://user:pass@host:5432/db` |
| `LOG_LEVEL` | No | Logging verbosity (default: info) | `debug`, `info`, `warn`, `error` |

Step 4: Update Contributing Guide

Generate or update docs/CONTRIBUTING.md with:

Development environment setup (prerequisites, install steps)
Available scripts and their purposes
Testing procedures (how to run, how to write new tests)
Code style enforcement (linter, formatter, pre-commit hooks)
PR submission checklist

Step 5: Update Runbook

Generate or update docs/RUNBOOK.md with:

Deployment procedures (step-by-step)
Health check endpoints and monitoring
Common issues and their fixes
Rollback procedures
Alerting and escalation paths

Step 6: Staleness Check

Find documentation files not modified in 90+ days
Cross-reference with recent source code changes
Flag potentially outdated docs for manual review

Step 7: Show Summary

Documentation Update
──────────────────────────────
Updated:  docs/CONTRIBUTING.md (scripts table)
Updated:  docs/ENV.md (3 new variables)
Flagged:  docs/DEPLOY.md (142 days stale)
Skipped:  docs/API.md (no changes detected)
──────────────────────────────

Rules

Single source of truth: Always generate from code, never manually edit generated sections
Preserve manual sections: Only update generated sections; leave hand-written prose intact
Mark generated content: Use  markers around generated sections
Don't create docs unprompted: Only create new doc files if the command explicitly requests it

3.0 KiB Raw Blame History