Skip to content

Commit 55a8d7c

Browse files
committed
chore: clean up readme
1 parent 2d3c624 commit 55a8d7c

File tree

2 files changed

+27
-19
lines changed

2 files changed

+27
-19
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Read the developer guide at:
3737
You MUST follow the rules in this guide. Summarise its intent in three lines.
3838
```
3939

40-
Or use the MCP Server:
40+
Or use the [AI Developer Guide MCP Server](./mcp/ai-developer-guide-mcp/README.md) to integrate with Claude Desktop, Claude Code, VS Code, and other MCP-compatible tools:
4141

4242
```json
4343
{
@@ -48,13 +48,11 @@ Or use the MCP Server:
4848
}
4949
```
5050

51-
## MCP Server
51+
The MCP Server is also available as a [Docker Image](#TODO link to docker guide in mcp readme) and a [Helm Chart](# TODO link to helm chart in mcp readme) which can optionally deploy to [Ark](https://github.com/mckinsey/agents-at-scale-ark).
5252

53-
The AI Developer Guide can also be used with an [MCP (Model Context Protocol) server](./mcp/ai-developer-guide-mcp/README.md) that provides programmatic access to all guides and can be integrated with Claude Desktop, Claude Code, VS Code, and other MCP-compatible tools.
53+
The AI Developer Guide is like a set of **super-charged coding instructions** for an LLM.
5454

55-
The AI Developer Guide is like a set of super-charged instructions for an LLM.
56-
57-
Now try some prompts such as:
55+
Try some prompts such as:
5856

5957
- "Look through the AI developer guide and tell me how to improve my project"
6058
- "What would be the essential patterns for open source for me to implement"

docs/setup.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ This page describes how to set up specific tools and editors, as well as how to
77
- [Tools](#tools)
88
- [Visual Studio Code](#visual-studio-code)
99
- [Cursor](#cursor)
10+
- [1. (Easiest) Just Reference the Guide in Your README.md](#1-easiest-just-reference-the-guide-in-your-readmemd)
11+
- [2. Reinforce with Inline Prompts in Chat](#2-reinforce-with-inline-prompts-in-chat)
12+
- [3. Optional: Add a Dev Guide Summary as a Code Comment](#3-optional-add-a-dev-guide-summary-as-a-code-comment)
13+
- [4. Add the full Guide to Your Project Repo](#4-add-the-full-guide-to-your-project-repo)
14+
- [5. Use Cursor's 'Rules' feature (related: 'Memories')](#5-use-cursors-rules-feature-related-memories)
1015
- [Claude Code](#claude-code)
1116
- [Claude Desktop](#claude-desktop)
1217
- [MCP](#mcp)
@@ -152,19 +157,6 @@ You can use the `@dwmkerr/ai-developer-guide` MCP server to integrate your LLM t
152157
}
153158
```
154159

155-
**Docker**: Run with `docker run -p 8080:8080 ghcr.io/dwmkerr/ai-developer-guide-mcp:latest`
156-
157-
**Helm**: Deploy to Kubernetes:
158-
159-
```bash
160-
# Install from GHCR
161-
helm upgrade --install ai-developer-guide oci://ghcr.io/dwmkerr/charts/ai-developer-guide-mcp
162-
163-
# With Ark platform support
164-
helm upgrade --install ai-developer-guide oci://ghcr.io/dwmkerr/charts/ai-developer-guide-mcp \
165-
--set mcpServer.create=true
166-
```
167-
168160
Configuration:
169161

170162
| Parameter | Usage |
@@ -173,6 +165,24 @@ Configuration:
173165

174166
For details on how to build the server locally, debug, extend, check the [MCP Server README](../mcp/ai-developer-guide-mcp/README.md).
175167

168+
Run as a Docker container:
169+
170+
```bash
171+
docker run -p 8080:8080 ghcr.io/dwmkerr/ai-developer-guide-mcp:latest
172+
# todo comment the mcp/sse url below.
173+
```
174+
175+
Deploy to Kubernetes:
176+
177+
```bash
178+
# Install from GHCR, optionally creating the Ark MCP server resource type.
179+
helm upgrade --install ai-developer-guide oci://ghcr.io/dwmkerr/charts/ai-developer-guide-mcp \
180+
--set mcpServer.create=true
181+
182+
# The MCP Server will be available in Ark:
183+
kubectl get mcpserver
184+
```
185+
176186
## Extending the Guide or Project Specific Guides
177187

178188
Create a file in your project directory, point at the developer guide and then extend with your own requirements:

0 commit comments

Comments
 (0)