Skip to content

Commit f8fb992

Browse files
authored
Merge pull request #28025 from microsoftgraph/author-api-docs-prompt-metadata
Author API docs prompt - Correct author and ms.subservice guidance
2 parents d038cd4 + 7ad7678 commit f8fb992

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

.github/prompts/author-api-docs.prompt.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,8 @@ For this scenario, the author should add these files to `temp-docstubs`:
278278

279279
### Additional prerequisites
280280
After gathering the inputs, you must also prompt the author to provide:
281-
- **author**: The value to use in the front matter `author` field across all new files
282-
- **ms.subservice**: The value to use in the front matter `ms.subservice` field across all new files
281+
- **author**: Value to replace TODO placeholders in the `author` field (only for new files or where TODO exists)
282+
- **ms.subservice**: Value to replace TODO placeholders in the `ms.subservice` field (only for new files or where TODO exists)
283283

284284
### Critical guidance on doc stubs
285285

@@ -992,9 +992,10 @@ When authoring or updating documentation, ensure compliance with these standards
992992
Before working on any file, apply these rules to both resource and API files:
993993

994994
### Front matter
995-
- **Replace TODO placeholders:**
996-
- Use the `author` value provided by the author
997-
- Use the `ms.subservice` value provided by the author
995+
- **Replace TODO placeholders only:**
996+
- If `author` field has TODO: replace with author-provided value
997+
- If `ms.subservice` field has TODO: replace with author-provided value
998+
- Do NOT update these fields if they already contain values
998999
- **[Optional] Improve the description:**
9991000
- Make it user-friendly and clear
10001001
- Use information from API.md to enhance it
@@ -1003,6 +1004,7 @@ Before working on any file, apply these rules to both resource and API files:
10031004
- `ms.date`
10041005
- `doc_type`
10051006
- `ms.localizationpriority`
1007+
- `author` and `ms.subservice` if already populated
10061008

10071009
### File body
10081010
- **H1 title:** Leave unchanged

0 commit comments

Comments
 (0)