Skip to content

docs: add Automation section covering ai-workflows, routines, /ship#30

Open
JacobPEvans wants to merge 3 commits into
mainfrom
docs/automation-surface
Open

docs: add Automation section covering ai-workflows, routines, /ship#30
JacobPEvans wants to merge 3 commits into
mainfrom
docs/automation-surface

Conversation

@JacobPEvans
Copy link
Copy Markdown
Owner

Summary

  • New top-level Automation nav group with seven pages covering the issue→mergeable-PR pipeline across ai-workflows, claude-code-routines, and claude-code-plugins.
  • Cross-links from existing pages (architecture/ai-pipeline.mdx, tools/automation.mdx, ai-development/claude-code-plugins.mdx) so the Automation section is reachable from the existing AI/tools surfaces.

What's in the new section

  • automation/overview — three-layer pipeline (tier 1 hub) with canonical end-to-end diagram
  • automation/issue-to-pr-pipeline — eight-step cloud flow on this repo
  • automation/ai-workflows — catalog of 16 reusable workflows, deprecated/disabled notes
  • automation/claude-code-routines — six cron routines, deploy-routines GHA workaround
  • automation/ship-and-finalize — /ship + /finalize-pr lifecycle with canonical five-phase diagram and known reliability gaps
  • automation/codeql-resolution — why CodeQL is fixed separately from CI
  • automation/shape-issues — /shape-issues local skill

Validations passed locally

  • jq empty docs.json OK
  • mint broken-links reports success no broken links found
  • grep '%%{init:' --include='*.mdx' -r . returns exactly 1 unique directive (canonical theme byte-for-byte)
  • Word counts within tier caps: tier 1 ≤ 450 (overview=435), tier 2 ≤ 900 (max=868)

Test plan

  • CI green
  • Visual check: mint dev locally, verify new Automation group renders in sidebar
  • Visual check: every new mermaid diagram renders correctly with the hand-drawn theme
  • Visual check: cross-linked Cards (4 from overview, 2 from ai-pipeline) navigate as expected

Related work

This is the documentation half of a larger effort. The wiring half (six ai-workflows callers in .github/workflows/) is filed as a separate PR after secrets-sync distributes the required secrets to this repo. The /ship reliability fix lands separately against claude-code-plugins.

Assisted-by: Claude noreply@anthropic.com

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
jacobpevans 🟢 Ready View Preview May 24, 2026, 4:31 PM

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a comprehensive "Automation" section to the documentation, detailing the mechanics of the issue-to-mergeable PR pipeline. It adds several new pages covering ai-workflows, claude-code-routines, codeql-resolution, shape-issues, and the /ship and /finalize-pr skills, while updating navigation and cross-references across existing files. Feedback from the review highlights a timezone inconsistency in the routine schedule and a count mismatch in the automation overview heading.

Comment thread automation/claude-code-routines.mdx Outdated
Comment thread automation/overview.mdx Outdated
JacobPEvans added a commit that referenced this pull request May 24, 2026
…g parts

Addresses gemini-code-assist review on PR #30:

- claude-code-routines.mdx: README in source repo lists all routines in
  CT, not UTC. Updated table header to "Schedule (CT)" and corrected
  every row to match the source-of-truth times from the README.
- overview.mdx: heading said "seven moving parts" but the CardGroup
  has six cards. Changed to "six moving parts".

Assisted-by: Claude <noreply@anthropic.com>
Adds a new top-level Automation nav group with seven pages covering the
end-to-end issue->mergeable-PR pipeline that spans three repos:

- automation/overview — the three-layer pipeline (cloud GHA, cron
  routines, local /ship) with a canonical end-to-end diagram
- automation/issue-to-pr-pipeline — the eight-step cloud flow on this
  repo, with which trigger fires which caller and what each does
- automation/ai-workflows — catalog of the 16 reusable workflows in
  JacobPEvans/ai-workflows: event-triggered, scheduled, and what's
  deprecated or disabled
- automation/claude-code-routines — the six cron-scheduled cloud
  routines: morning briefing, sentinel, custodian, issue solver, daily
  polish, weekly scorecard; the deploy-routines GHA workaround
- automation/ship-and-finalize — /ship + /finalize-pr lifecycle with
  the canonical five-phase diagram and the known reliability gaps
  being closed in a follow-up against claude-code-plugins
- automation/codeql-resolution — why CodeQL is fixed separately from
  CI checks, and how /resolve-codeql plugs into /finalize-pr Phase 2
- automation/shape-issues — the /shape-issues local skill and how it
  feeds well-scoped issues into the resolver pipeline

Cross-links from existing pages:
- architecture/ai-pipeline.mdx -> /automation/overview (mechanics)
- tools/automation.mdx -> /automation/overview + /automation/ship-and-finalize
- ai-development/claude-code-plugins.mdx -> /automation/ship-and-finalize
  + replaces direct GitHub links with /automation/* internal links for
  claude-code-routines and ai-workflows

All new diagrams use the canonical hand-drawn Reef Green theme directive
byte-for-byte; grep validates one unique directive across the site.
Word counts within tier caps (tier 1 <=450, tier 2 <=900). All internal
links validated by mint broken-links.

Assisted-by: Claude <noreply@anthropic.com>
…g parts

Addresses gemini-code-assist review on PR #30:

- claude-code-routines.mdx: README in source repo lists all routines in
  CT, not UTC. Updated table header to "Schedule (CT)" and corrected
  every row to match the source-of-truth times from the README.
- overview.mdx: heading said "seven moving parts" but the CardGroup
  has six cards. Changed to "six moving parts".

Assisted-by: Claude <noreply@anthropic.com>
…I key

ai-workflows now authenticates directly against the Anthropic API
using ANTHROPIC_API_KEY, drawing from the Claude Max plan's
$200/month automation credits. OpenRouter remains supported as a
fallback provider but is no longer the default.

- ai-workflows.mdx: Authentication section rewritten; secret list
  swapped (ANTHROPIC_API_KEY replaces OPENROUTER_API_KEY +
  OPENROUTER_BASE_URL); fallback mention kept for completeness;
  "Where to go next" cards updated.
- issue-to-pr-pipeline.mdx: secrets table updated; auth card
  description matches the new default.

Assisted-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant