Skip to content

docs: reframe pitch as workload-agnostic and document workflow activation#77

Merged
arnaudlh merged 3 commits into
mainfrom
docs/workload-agnostic-pitch-and-activation
May 11, 2026
Merged

docs: reframe pitch as workload-agnostic and document workflow activation#77
arnaudlh merged 3 commits into
mainfrom
docs/workload-agnostic-pitch-and-activation

Conversation

@arnaudlh
Copy link
Copy Markdown
Member

Summary

Documentation audit fixes — reframe the project pitch as workload-agnostic (any Azure workload), document the .exampleyml → .yml activation convention, fix install snippets, remove stale workflow references, and add two new end-to-end deployment examples.

Changes

Pitch (workload-agnostic)

  • README.md, plugin.json, website/docs/intro.md, website/docs/vision.md — removed enumerations of workload types from lead sentences and "Built for" bullets
  • plugin.json keywords: dropped infrastructure/iac, added workloads/copilot-agents
  • Workload types now appear only in concrete examples

Workflow activation

  • Added :::info[Activation required] callouts to the workflows overview and each *.exampleyml page explaining the rename step performed by /git-ape-onboarding
  • Explicit callout in website/docs/getting-started/onboarding.md

Install snippet consistency

  • Corrected copilot plugin install form across intro.md and personas/for-engineers.mdx to use git-ape@git-ape and added copilot plugin li

Stale references removed

  • Dropped git-ape-drift.yml and git-ape-ttl-reaper.yml from the WORKFLOWS array in .github/workflows/git-ape-verify.exampleyml
  • Removed stale @azure-iac-generator row from use-cases/import-existing-infra.md

Examples

  • Added Example 3 (AI knowledge-base: Function App + Azure OpenAI + AI Search) and Example 4 (streaming data platform: Event Hubs + Stream Analytics + ADLS Gen2) to use-cases/deploy-anything.md

Generator

  • scripts/generate-docs.js: moved azure-rest-api-reference to Pre-Deploy phase; emits activation callout for .exampleyml pages
  • Auto-generated 7 new workflow pages now reflecting all CI workflows under .github/workflows/

Validation

  • node scripts/validate-structure.js → PASSED
  • npm run build (Docusaurus) → SUCCESS
  • actionlint -config-file .github/actionlint.yaml → clean
  • Generator output: 8 agents, 13 skills, 13 workflows

…tion

- reframe README, plugin.json, intro, vision around any Azure workload
- add .exampleyml activation callouts on workflow pages and onboarding
- fix install snippet to use git-ape@git-ape across docs
- remove stale git-ape-drift / ttl-reaper refs from verify workflow
- add AI knowledge-base and streaming data platform examples
- move azure-rest-api-reference to Pre-Deploy in generator

📚 - Generated by Copilot
@arnaudlh arnaudlh added documentation Improvements or additions to documentation Website labels May 11, 2026
@arnaudlh arnaudlh requested a review from sendtoshailesh May 11, 2026 03:06
@arnaudlh arnaudlh self-assigned this May 11, 2026
@arnaudlh arnaudlh requested review from suuus May 11, 2026 08:27
@suuus suuus requested a review from Copilot May 11, 2026 09:53
@arnaudlh arnaudlh added this to the v0.0.2 milestone May 11, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates Git-Ape’s documentation to position the project as workload-agnostic (any Azure workload), documents the *.exampleyml → *.yml workflow activation convention, refreshes workflow documentation pages via the docs generator, and adds new end-to-end deployment examples.

Changes:

  • Reframes the project pitch across README/plugin docs to emphasize “any Azure workload” and removes stale workflow references.
  • Documents workflow activation (renaming *.exampleyml to *.yml) in onboarding + workflow docs, and updates the docs generator to emit activation callouts.
  • Adds new deployment examples and regenerates workflow reference pages to reflect current .github/workflows/*.
Show a summary per file
File Description
website/docs/workflows/pr-validation.md Adds auto-generated documentation page for the PR validation workflow.
website/docs/workflows/overview.md Updates workflow inventory and adds an activation-required callout.
website/docs/workflows/issue-triage-agent-lock.md Adds auto-generated documentation page for the issue triage agent lock workflow.
website/docs/workflows/git-ape-verify.md Documents activation requirement for the git-ape-verify.exampleyml workflow and removes stale workflow references.
website/docs/workflows/git-ape-release.md Adds auto-generated documentation page for the plugin release workflow.
website/docs/workflows/git-ape-plugin-version-check.md Adds auto-generated documentation page for the plugin version drift check workflow.
website/docs/workflows/git-ape-plan.md Adds activation-required callout for the plan workflow documentation page.
website/docs/workflows/git-ape-docs.md Updates docs workflow page to reflect current action versions/node versions.
website/docs/workflows/git-ape-docs-check.md Updates docs-check workflow page to reflect current action versions/node versions.
website/docs/workflows/git-ape-destroy.md Adds activation-required callout for the destroy workflow documentation page.
website/docs/workflows/git-ape-deploy.md Adds activation-required callout for the deploy workflow documentation page.
website/docs/workflows/git-ape-build.md Adds auto-generated documentation page for the extension build workflow.
website/docs/workflows/git-ape-actionlint.md Adds auto-generated documentation page for the workflow lint workflow.
website/docs/workflows/daily-repo-status-lock.md Adds auto-generated documentation page for the daily repo status lock workflow.
website/docs/vision.md Adjusts the vision/pitch text to emphasize workload-agnostic deployments.
website/docs/use-cases/import-existing-infra.md Removes a stale use-case reference.
website/docs/use-cases/deploy-anything.md Adds two new end-to-end deployment examples with diagrams and prompts.
website/docs/skills/overview.md Moves azure-rest-api-reference into the Pre-Deploy phase and updates the phase diagram.
website/docs/skills/azure-rest-api-reference.md Updates the skill “Phase” classification to Pre-Deploy.
website/docs/reference/plugin-json.md Updates the documented plugin manifest description and keywords to match the new positioning.
website/docs/reference/marketplace.md Updates marketplace documentation to include the additional plugin entry.
website/docs/personas/for-engineers.mdx Updates Copilot CLI install snippet for consistency with other docs.
website/docs/intro.md Reframes the intro pitch as workload-agnostic and fixes CLI install snippet.
website/docs/getting-started/onboarding.md Adds explicit workflow activation guidance as part of onboarding.
scripts/generate-docs.js Updates skill phase classification and adds activation-required callouts to generated workflow pages and overview.
README.md Reframes the project pitch, updates skill/workflow descriptions, and refreshes included components listing.
plugin.json Updates plugin description and keywords to match workload-agnostic positioning.
.github/workflows/git-ape-verify.exampleyml Removes stale workflow entries from the verify workflow’s internal workflow list.

Copilot's findings

  • Files reviewed: 28/28 changed files
  • Comments generated: 4

Comment thread website/docs/workflows/overview.md
Comment thread scripts/generate-docs.js
Comment thread website/docs/personas/for-engineers.mdx Outdated
Comment thread website/docs/skills/overview.md Outdated
suuus and others added 2 commits May 11, 2026 12:04
typo fix

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
readability

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

⚠️ Documentation Staleness Warning

Source files (agents, skills, workflows, or config) changed in this PR, but the generated documentation is out of date.

Changed docs that need regeneration:

  • website/docs/skills/overview.md

To fix: Run the following command and commit the results:

node scripts/generate-docs.js

This is an advisory check — it does not block the PR.

Copy link
Copy Markdown
Contributor

@suuus suuus left a comment

Choose a reason for hiding this comment

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

Squirrel says: ship it

@arnaudlh arnaudlh merged commit 21ac1cb into main May 11, 2026
8 checks passed
@arnaudlh arnaudlh deleted the docs/workload-agnostic-pitch-and-activation branch May 11, 2026 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants