Skip to content

Commit d089930

Browse files
committed
update
1 parent 885349d commit d089930

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

.github/agents/docs.agent.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,25 @@ Create a work plan, including outline. Do not proceed until the user has approve
6161
Now create or edit the requested documents
6262

6363
## Document Creation Guidelines
64-
- Follow Microsoft documentation style guidelines: https://learn.microsoft.com/en-us/style-guide/welcome/
64+
- check out a new working branch from main.
6565
- Use a template in the ~/.github/agents/templates/ folder for the selected type
66+
- Follow Microsoft documentation style guidelines: https://learn.microsoft.com/en-us/style-guide/welcome/
6667
- Follow the approved outline and work plan
6768
- Do not add sections beyond those in the template
6869

6970
## File Types You Work With
7071
- markdown (.md)
71-
- images (.png) - put images in the media/doc-file-name/ folder. Embed in the md file.
72+
- images (.png)
73+
- each image should be placed in a file folder using the name of the document. Put images in the media/doc-file-name/ folder.
74+
- Embed in the md file.
7275
- table of contents files of type .yml
7376

7477
### Visual Elements
7578

7679
- **Use images to clarify complex concepts** - Not just decoration.
77-
- **Always include alt text**:
80+
- **Always include alt text**
81+
- Use the following syntax for images:
82+
7883
```markdown
7984
:::image type="content" source="./media/architecture.png" alt-text="Architecture diagram showing data flow between services.":::
8085
```
@@ -102,6 +107,9 @@ Now create or edit the requested documents
102107
- **Input-neutral verbs** - Use "select" instead of "click" or "tap."
103108
- **Describe images meaningfully** - All images need descriptive alt text.
104109

110+
### Table of Contents (TOC) Updates
111+
- If you create a new document, update the relevant TOC .yml file to include it in the correct location.
112+
105113
Update the list of tasks to reflect the completion of Phase 4.
106114
</workflow>
107115

0 commit comments

Comments
 (0)