Files
ai-coding-skills/docs/README.md
T
stefano 251148c3ff
check / check (ubuntu-latest) (push) Successful in 2m5s
check / check (macos-latest) (push) Has been cancelled
check-online / check-online (ubuntu-latest) (push) Successful in 1m53s
Perform code optimization and document cleanup (#1)
## Summary
- add repository-wide quality tooling and verification scaffolding, including CI workflows, pnpm workspace setup, ESLint/Prettier/markdown checks, and generated-output verification helpers
- reorganize skill sources and generation flow by introducing canonical `_source` variants, generator/manifests, reusable helper abstractions, and shared web-automation/browser utilities
- clean up and expand documentation so the root README flows into docs and skill docs, with clearer development, reviewer, installer, and workflow guidance

## Notable changes
- docs flow and consistency cleanup across `README.md`, `docs/README.md`, and related docs
- new scripts for `check`, docs verification, generated-file verification, shell portability, and safe directory replacement
- refactors in Atlassian and web-automation skill runtimes to reduce duplication and centralize reusable code
- changelog, development documentation, and CI surface updates

## Test Plan
- [ ] `pnpm run check`
- [ ] review generated/manifests and skill sync outputs
- [ ] smoke-check docs flow from `README.md` to `docs/README.md` to skill docs

## Notes
- this branch currently includes tracked `skills/web-automation/shared/node_modules` content that should be reviewed carefully as potentially noisy/accidental committed artifacts

Co-authored-by: Stefano Fiorini <stefano.fiorini@firsthorizon.com>
Reviewed-on: #1
2026-05-04 04:41:34 +00:00

2.9 KiB

Skills Documentation

This directory contains user-facing docs for all skills, agents, and tooling in the ai-coding-skills repository.

Reading Order

Work through the sections below in order on a first read. Return to individual sections as needed.

1. Getting Started

  • INSTALLER.md — Guided install/update/remove wizard (./scripts/manage-skills.sh). Start here if you want the fastest path to installed skills.

2. Per-Agent Manual Install

Use these guides to install specific skills manually for a single agent:

  • CODEX.md — Manual install for Codex variants.
  • CLAUDE-CODE.md — Manual install for Claude Code variants.
  • CURSOR.md — Manual install for Cursor variants.
  • OPENCODE.md — Manual install for OpenCode variants.
  • PI.md — Pi overview, source-vs-package layout, and manual install.

3. Skill Guides

Reference docs for each skill family:

  • ATLASSIAN.md — Jira/Confluence CLI: requirements, generated bundle sync, install, auth, safety rules, and usage examples.
  • CREATE-PLAN.md — Structured planning with milestones, cross-model review, and reviewer CLI requirements.
  • DO-TASK.md — Single-prompt end-to-end execution with dual reviewer loops, TDD-first, single task commit.
  • IMPLEMENT-PLAN.md — Worktree-isolated plan execution with iterative cross-model milestone review.
  • WEB-AUTOMATION.md — CloakBrowser-backed browsing, scraping, auth, and flow automation.

4. Pi-Specific Docs

  • PI-RESEARCH.md — Source-backed Pi findings that inform repo Pi variants and packaging choices.
  • PI-SUPERPOWERS.md — How to install or verify Obra Superpowers for Pi.
  • PI-COMMON-REVIEWER.md — Shared reviewer-runtime helpers for Pi workflow skills; canonical Pi reviewer flag contract.

5. Telegram Notifications

6. Reviewer Matrix

  • REVIEWERS.md — Canonical reviewer CLI support matrix; single source of truth for all workflow variants.

7. Development

  • DEVELOPMENT.md — Prerequisites, pnpm run check, workspace policy, generation workflow, cross-platform shell support, and the quality contract.
  • CLEANUP-BASELINE.md — As-is quality baseline captured at M1, updated through subsequent milestones.
  • ../CHANGELOG.md — Milestone-by-milestone change record (includes M3 package-metadata rename table).

Repo Setup

Clone the repo first:

git clone https://git.fiorinis.com/Home/ai-coding-skills.git
cd ai-coding-skills