You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+79-53Lines changed: 79 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,18 +7,27 @@ To ensure consistent and context-aware assistance from ChatGPT or Claude Code, u
7
7
```md
8
8
You are assisting with technical documentation for the open source Coder project (https://github.com/coder/coder). You should follow the rules and preferences outlined in these files:
9
9
10
-
- style-guide.md (formatting and tone rules)
11
-
- architecture-notes.md (high-level architecture of the product)
1. ai-project-notes.md (recent work log and in-progress ideas)
19
+
20
+
1. claude-code-config.md (rules for Claude's behavior)
16
21
17
22
You are not responsible for copyediting or tone unless asked; focus on:
18
-
- technical accuracy (based on the codebase and documented architecture)
19
-
- adherence to file placement and structure
20
-
- verifying commands, parameters, and file references
21
-
- following our markdown and terminology conventions
23
+
24
+
1. technical accuracy (based on the codebase and documented architecture)
25
+
26
+
1. adherence to file placement and structure
27
+
28
+
1. verifying commands, parameters, and file references
29
+
30
+
1. following our markdown and terminology conventions
22
31
23
32
Do not use emojis in headings or list items. Use relative paths in links. If you're unsure, ask before making assumptions.
24
33
```
@@ -34,19 +43,22 @@ This directory — `coder-docs-writing/` — is meant to live alongside the `cod
34
43
---
35
44
36
45
## Purpose
46
+
37
47
This repo acts as a **persistent memory store** for markdown/style preferences, architectural understanding, and AI-generated notes. It is designed to:
38
48
39
-
- Serve as a **sidecar knowledgebase** for the primary maintainer (Edward Angert)
40
-
- Act as an **AI Subject Matter Expert (AI-SME)** for use in LLM workflows
41
-
- Be a **shared workspace** for coworkers to contribute insights, style clarifications, architecture notes, and documentation patterns
49
+
1. Serve as a **sidecar knowledgebase** for the primary maintainer (Edward Angert)
50
+
51
+
1. Act as an **AI Subject Matter Expert (AI-SME)** for use in LLM workflows
52
+
53
+
1. Be a **shared workspace** for coworkers to contribute insights, style clarifications, architecture notes, and documentation patterns
42
54
43
55
The goal is to reduce context-switching, enforce style and consistency, and enable teammates or AI to step in seamlessly.
44
56
45
57
---
46
58
47
59
## Structure
48
60
49
-
```
61
+
```text
50
62
coder-docs-writing/
51
63
├── README.md # This file
52
64
├── style-guide.md # Markdown and tone/style preferences
@@ -66,28 +78,23 @@ Documentation paths should refer to content under `../coder/docs/`. Image assets
66
78
67
79
## Getting Started
68
80
69
-
1.**Clone the repo locally** (or fork it for sandboxed edits):
0 commit comments