Skip to content

docs: add prompt files documentation#201

Merged
EMaher merged 12 commits into
emaher-rename-and-rewrite-init-filesfrom
emaher-docs-prompt-files
Jun 30, 2026
Merged

docs: add prompt files documentation#201
EMaher merged 12 commits into
emaher-rename-and-rewrite-init-filesfrom
emaher-docs-prompt-files

Conversation

@EMaher

@EMaher EMaher commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a new documentation article at docs/guides/prompt-files.md that describes the prompt files available in the repository and how to use them independently of apiops init.

What's included

  • Table listing all available prompt files and their purpose
  • Download instructions for Bash and PowerShell to fetch prompt files directly from the repo
  • Usage guidance for VS Code (with links to official docs on reusable prompt files)
  • Usage guidance for GitHub Copilot CLI (with links to official docs)
  • Links to related guides (filtering, environment overrides, init command)

Related Issue(s)

N/A — documentation enhancement

Base branch

This PR targets emaher-rename-and-rewrite-init-files since it depends on the prompt markdown files introduced in that branch.

Describes available prompt files, how to download them individually
(bash and PowerShell), and how to use them in VS Code and GitHub
Copilot CLI.
@EMaher EMaher changed the base branch from main to emaher-rename-and-rewrite-init-files June 29, 2026 22:25
@EMaher EMaher marked this pull request as draft June 29, 2026 22:26
@EMaher EMaher self-assigned this Jun 29, 2026
@EMaher EMaher marked this pull request as ready for review June 29, 2026 22:54
@EMaher EMaher requested a review from petehauge June 29, 2026 22:56

@petehauge petehauge left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good idea!

@EMaher EMaher merged commit 7498473 into emaher-rename-and-rewrite-init-files Jun 30, 2026
1 check passed
EMaher added a commit that referenced this pull request Jul 1, 2026
* feat(init): rename output files and rewrite manual guides for UI focus

- Rename manual guide: IDENTITY-SETUP-GITHUB.md → APIOPS-WORKFLOW-IDENTITY-SETUP.md
- Rename manual guide: IDENTITY-SETUP-AZDO.md → APIOPS-PIPELINE-IDENTITY-SETUP.md
- Rename prompt: apiops-setup-identity.prompt.md → apiops-setup-{workflow|pipeline}-identity.prompt.md
- Rewrite manual guides to focus on web UI steps with documentation links
- Add note about identity distinction (Azure access vs PR creation)
- Add reference to prompt file in manual guides

* docs: update Azure DevOps identity guide title
* docs: add official doc links to all UI navigation steps

Adds a reference link to the relevant Microsoft/GitHub docs page
above every section that instructs the user to navigate a web UI,
so readers have a fallback if the UI changes.

* refactor: remove all token injection from manual identity guides

Manual guide markdown files are now fully static with generic
'for each environment' instructions. No more dynamic rendering —
the identity-guide-service just returns the template content as-is.
This makes the guides easier to maintain.

* refactor: inline Azure DevOps core template into prompt file

Combines src/templates/shared/identity-setup-azure-devops-core.md directly
into the Azure DevOps prompt template, eliminating a level of indirection.
The two dynamic tokens (ENVIRONMENTS_ARRAY_POWERSHELL/BASH) are now
rendered directly in the prompt template.

* docs: add prompt files documentation (#201)

Describes available prompt files, how to download them individually
(bash and PowerShell), and how to use them in VS Code and GitHub
Copilot CLI.

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.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.

2 participants