Add 'agents' folder creation instructions#42107
Add 'agents' folder creation instructions#42107MikeGBurns wants to merge 1 commit intogithub:mainfrom
Conversation
Added instructions for creating an 'agents' folder for organization agents.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
There was a problem hiding this comment.
Pull request overview
This PR adds a new instruction step for creating an agents folder in organization-level custom agent setup documentation. The change helps differentiate between the organization-level agents folder and the repository-level .github/agents folder.
Key Changes:
- Adds a new step (line 32) instructing users to create an
agentsfolder in the root directory for defining organization agents
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * To **manually grant access after creation**, or if internal visibility is not an option, click {% octicon "lock" aria-hidden="true" aria-label="lock" %} **Private**. | ||
| {% data reusables.repositories.create-repo %} | ||
| 1. Update the template README as needed. Consider including creation guidelines for {% data variables.copilot.custom_agents_short %} or compliance considerations specific to your organization. | ||
| 1. Create folder `agents` in the root folder. This is where your organization agents will be defined. |
There was a problem hiding this comment.
The instruction "Create folder" should be changed to "Create a directory named" to match the consistent pattern used throughout the documentation. For example, other documentation files use phrasing like "Create a directory named workflow-templates."
| 1. Create folder `agents` in the root folder. This is where your organization agents will be defined. | |
| 1. Create a directory named `agents` in the root directory. This is where your organization agents will be defined. |
| * To **manually grant access after creation**, or if internal visibility is not an option, click {% octicon "lock" aria-hidden="true" aria-label="lock" %} **Private**. | ||
| {% data reusables.repositories.create-repo %} | ||
| 1. Update the template README as needed. Consider including creation guidelines for {% data variables.copilot.custom_agents_short %} or compliance considerations specific to your organization. | ||
| 1. Create folder `agents` in the root folder. This is where your organization agents will be defined. |
There was a problem hiding this comment.
There are two spaces after the period instead of one. This should be a single space to maintain consistent spacing throughout the documentation.
| 1. Create folder `agents` in the root folder. This is where your organization agents will be defined. | |
| 1. Create folder `agents` in the root folder. This is where your organization agents will be defined. |
| * To **manually grant access after creation**, or if internal visibility is not an option, click {% octicon "lock" aria-hidden="true" aria-label="lock" %} **Private**. | ||
| {% data reusables.repositories.create-repo %} | ||
| 1. Update the template README as needed. Consider including creation guidelines for {% data variables.copilot.custom_agents_short %} or compliance considerations specific to your organization. | ||
| 1. Create folder `agents` in the root folder. This is where your organization agents will be defined. |
There was a problem hiding this comment.
The phrase "in the root folder" is redundant. Based on the established pattern in the documentation (e.g., "Create a directory named workflow-templates"), the location should be included as part of the directory name description rather than as a separate phrase. The instruction should simply specify creating the agents directory without the redundant "in the root folder" phrase.
| 1. Create folder `agents` in the root folder. This is where your organization agents will be defined. | |
| 1. Create a directory named `agents`. This is where your organization's agents will be defined. |
|
@MikeGBurns Thanks for opening a PR! I'm going to make sure this is where we would want to document this. |
Added instructions for creating an 'agents' folder for organization agents.
Why:
Improve documentation to differentiate between folder
agents, which is used for organization-level agents from.github/agentswhich is used for repository-level agents.Closes: #
What's being changed (if available, include any code snippets, screenshots, or gifs):
Added folder creation step for folder
agents.Check off the following: