Skip to content

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

Open
arnaudlh wants to merge 1 commit intomainfrom
docs/workload-agnostic-pitch-and-activation
Open

docs: reframe pitch as workload-agnostic and document workflow activation#77
arnaudlh wants to merge 1 commit intomainfrom
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
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.

1 participant