From a1906ef8a8b20610a30a3ffbbd29cb787d26c937 Mon Sep 17 00:00:00 2001 From: Aaron Powell Date: Tue, 28 Oct 2025 13:48:52 +1100 Subject: [PATCH] docs: relocate category READMEs to /docs and update generation + internal links --- README.md | 14 +++++++------- docs/.gitkeep | 0 README.agents.md => docs/README.agents.md | 0 .../README.chatmodes.md | 0 .../README.collections.md | 0 .../README.instructions.md | 0 README.prompts.md => docs/README.prompts.md | 0 eng/constants.js | 3 +++ eng/update-readme.js | 18 ++++++++++++------ 9 files changed, 22 insertions(+), 13 deletions(-) create mode 100644 docs/.gitkeep rename README.agents.md => docs/README.agents.md (100%) rename README.chatmodes.md => docs/README.chatmodes.md (100%) rename README.collections.md => docs/README.collections.md (100%) rename README.instructions.md => docs/README.instructions.md (100%) rename README.prompts.md => docs/README.prompts.md (100%) diff --git a/README.md b/README.md index 09b4576..47692c3 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ A curated collection of prompts, instructions, and chat modes to supercharge you This repository provides a comprehensive toolkit for enhancing GitHub Copilot with specialized: -- **👉 [Awesome Agents](README.agents.md)** - Specialized GitHub Copilot agents that integrate with MCP servers to provide enhanced capabilities for specific workflows and tools -- **👉 [Awesome Prompts](README.prompts.md)** - Focused, task-specific prompts for generating code, documentation, and solving specific problems -- **👉 [Awesome Instructions](README.instructions.md)** - Comprehensive coding standards and best practices that apply to specific file patterns or entire projects -- **👉 [Awesome Chat Modes](README.chatmodes.md)** - Specialized AI personas and conversation modes for different roles and contexts -- **👉 [Awesome Collections](README.collections.md)** - Curated collections of related prompts, instructions, and chat modes organized around specific themes and workflows +- **👉 [Awesome Agents](docs/README.agents.md)** - Specialized GitHub Copilot agents that integrate with MCP servers to provide enhanced capabilities for specific workflows and tools +- **👉 [Awesome Prompts](docs/README.prompts.md)** - Focused, task-specific prompts for generating code, documentation, and solving specific problems +- **👉 [Awesome Instructions](docs/README.instructions.md)** - Comprehensive coding standards and best practices that apply to specific file patterns or entire projects +- **👉 [Awesome Chat Modes](docs/README.chatmodes.md)** - Specialized AI personas and conversation modes for different roles and contexts +- **👉 [Awesome Collections](docs/README.collections.md)** - Curated collections of related prompts, instructions, and chat modes organized around specific themes and workflows ## 🌟 Featured Collections @@ -103,7 +103,7 @@ We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING. ## 🌟 Getting Started -1. **Browse the Collections**: Check out our comprehensive lists of [prompts](README.prompts.md), [instructions](README.instructions.md), [chat modes](README.chatmodes.md), and [collections](README.collections.md). +1. **Browse the Collections**: Check out our comprehensive lists of [prompts](docs/README.prompts.md), [instructions](docs/README.instructions.md), [chat modes](docs/README.chatmodes.md), and [collections](docs/README.collections.md). 2. **Add to your editor**: Click the "Install" button to install to VS Code, or copy the file contents for other editors. 3. **Start Using**: Copy prompts to use with `/` commands, let instructions enhance your coding experience, or activate chat modes for specialized assistance. @@ -126,7 +126,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file --- -**Ready to supercharge your coding experience?** Start exploring our [prompts](README.prompts.md), [instructions](README.instructions.md), and [chat modes](README.chatmodes.md)! +**Ready to supercharge your coding experience?** Start exploring our [prompts](docs/README.prompts.md), [instructions](docs/README.instructions.md), and [chat modes](docs/README.chatmodes.md)! ## Contributors ✨ diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/README.agents.md b/docs/README.agents.md similarity index 100% rename from README.agents.md rename to docs/README.agents.md diff --git a/README.chatmodes.md b/docs/README.chatmodes.md similarity index 100% rename from README.chatmodes.md rename to docs/README.chatmodes.md diff --git a/README.collections.md b/docs/README.collections.md similarity index 100% rename from README.collections.md rename to docs/README.collections.md diff --git a/README.instructions.md b/docs/README.instructions.md similarity index 100% rename from README.instructions.md rename to docs/README.instructions.md diff --git a/README.prompts.md b/docs/README.prompts.md similarity index 100% rename from README.prompts.md rename to docs/README.prompts.md diff --git a/eng/constants.js b/eng/constants.js index a55ca46..bb7c785 100644 --- a/eng/constants.js +++ b/eng/constants.js @@ -113,6 +113,8 @@ const AGENTS_DIR = path.join(ROOT_FOLDER, "agents"); const COLLECTIONS_DIR = path.join(ROOT_FOLDER, "collections"); const MAX_COLLECTION_ITEMS = 50; +const DOCS_DIR = path.join(ROOT_FOLDER, "docs"); + module.exports = { TEMPLATES, vscodeInstallImage, @@ -126,4 +128,5 @@ module.exports = { AGENTS_DIR, COLLECTIONS_DIR, MAX_COLLECTION_ITEMS, + DOCS_DIR, }; diff --git a/eng/update-readme.js b/eng/update-readme.js index 200ef77..211a865 100755 --- a/eng/update-readme.js +++ b/eng/update-readme.js @@ -20,6 +20,7 @@ const { AGENTS_DIR, COLLECTIONS_DIR, INSTRUCTIONS_DIR, + DOCS_DIR, } = require("./constants"); // Cache of MCP registry server names (lower-cased) loaded from github-mcp-registry.json @@ -872,22 +873,27 @@ try { TEMPLATES.collectionsUsage ); - // Write category outputs + // Ensure docs directory exists for category outputs + if (!fs.existsSync(DOCS_DIR)) { + fs.mkdirSync(DOCS_DIR, { recursive: true }); + } + + // Write category outputs into docs folder writeFileIfChanged( - path.join(ROOT_FOLDER, "README.instructions.md"), + path.join(DOCS_DIR, "README.instructions.md"), instructionsReadme ); writeFileIfChanged( - path.join(ROOT_FOLDER, "README.prompts.md"), + path.join(DOCS_DIR, "README.prompts.md"), promptsReadme ); writeFileIfChanged( - path.join(ROOT_FOLDER, "README.chatmodes.md"), + path.join(DOCS_DIR, "README.chatmodes.md"), chatmodesReadme ); - writeFileIfChanged(path.join(ROOT_FOLDER, "README.agents.md"), agentsReadme); + writeFileIfChanged(path.join(DOCS_DIR, "README.agents.md"), agentsReadme); writeFileIfChanged( - path.join(ROOT_FOLDER, "README.collections.md"), + path.join(DOCS_DIR, "README.collections.md"), collectionsReadme );