awesome-copilot/prompts/update_llms.prompt.md
Daniel Scott-Raynsford 8229a03986 feat: Add comprehensive documentation prompts for OO components, specifications, and .NET best practices
- Introduced a prompt for creating standardized documentation for object-oriented components, adhering to industry best practices and architectural standards.
- Added a prompt for generating new specification files optimized for Generative AI consumption, including best practices for AI-ready specifications.
- Created a prompt for reviewing .NET/C# code against best practices, focusing on documentation, design patterns, dependency injection, and error handling.
- Developed a prompt for reviewing design pattern implementations in .NET/C# code, providing a checklist and improvement focus areas.
- Implemented a prompt for updating Azure Verified Modules in Bicep files to the latest versions, including a breaking change policy.
- Added a prompt for updating existing implementation plans with new requirements or updates to existing code.
- Created a prompt for updating the llms.txt file to reflect changes in documentation or specifications.
- Developed a prompt for updating markdown file sections with an index/table of files from specified folders.
- Introduced a prompt for updating existing object-oriented component documentation based on current implementation.
- Added a prompt for updating existing specifications based on new requirements or code updates.
2025-07-06 11:01:46 +12:00

39 lines
2.0 KiB
Markdown

---
mode: 'agent'
description: 'Update the llms.txt file in the root folder to reflect changes in documentation or specifications'
tools: ['changes', 'codebase', 'editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'searchResults', 'terminalLastCommand', 'terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
---
# Update LLMs Guidance File
Your task is to update the [llms.txt](/llms.txt) file located in the root of the repository. This file provides high-level guidance to large language models (LLMs) on where to find relevant content for understanding the solution's purpose and specifications.
**Instructions:**
- Ensure the `llms.txt` file accurately references all folders and files that are important for LLM comprehension, including the `specs/` folder (for machine-readable specifications) and the `docs/` folder (for developer and user documentation).
- If new documentation or specification folders/files are added, update `llms.txt` accordingly.
- Use clear, concise language and structured formatting for easy parsing by LLMs.
- Do not include implementation details or code—focus on navigation and content discovery.
Example structure for `llms.txt`:
```txt
# Solution: [Concise Title Describing the Solution's Purpose]
**Version:** [Optional: e.g., 1.0, Date]
**Last Updated:** [Optional: YYYY-MM-DD]
**Owner:** [Optional: Team/Individual responsible for this solution]
**GitHub Repository:** https://github.com/PlagueHO/azure-ai-foundry-jumpstart
## 1. Purpose & Scope
[Provide a clear, concise description of the purpose of this repository and scope of its solution. State the intended audience and any assumptions.]
## 2. Folder Structure
[Describe the structure of the repository, including the purpose of each folder and file. Use visual folder structure. Include subfolders where applicable.]
## 3. Important Files
[Explicitly list all important files, their purpose, and how they relate to the solution. Use bullet points or tables for clarity.]
```