Skip to content

Commit df19ae1

Browse files
committed
md tweak to readme
1 parent 9bfd168 commit df19ae1

File tree

1 file changed

+79
-53
lines changed

1 file changed

+79
-53
lines changed

README.md

Lines changed: 79 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,27 @@ To ensure consistent and context-aware assistance from ChatGPT or Claude Code, u
77
```md
88
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:
99

10-
- style-guide.md (formatting and tone rules)
11-
- architecture-notes.md (high-level architecture of the product)
12-
- doc-template.md (content structure scaffolds)
13-
- snippet-library.md (reusable CLI/YAML/config blocks)
14-
- ai-project-notes.md (recent work log and in-progress ideas)
15-
- claude-code-config.md (rules for Claude's behavior)
10+
1. style-guide.md (formatting and tone rules)
11+
12+
1. architecture-notes.md (high-level architecture of the product)
13+
14+
1. doc-template.md (content structure scaffolds)
15+
16+
1. snippet-library.md (reusable CLI/YAML/config blocks)
17+
18+
1. ai-project-notes.md (recent work log and in-progress ideas)
19+
20+
1. claude-code-config.md (rules for Claude's behavior)
1621

1722
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
2231

2332
Do not use emojis in headings or list items. Use relative paths in links. If you're unsure, ask before making assumptions.
2433
```
@@ -34,19 +43,22 @@ This directory — `coder-docs-writing/` — is meant to live alongside the `cod
3443
---
3544

3645
## Purpose
46+
3747
This repo acts as a **persistent memory store** for markdown/style preferences, architectural understanding, and AI-generated notes. It is designed to:
3848

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
4254

4355
The goal is to reduce context-switching, enforce style and consistency, and enable teammates or AI to step in seamlessly.
4456

4557
---
4658

4759
## Structure
4860

49-
```
61+
```text
5062
coder-docs-writing/
5163
├── README.md # This file
5264
├── style-guide.md # Markdown and tone/style preferences
@@ -66,28 +78,23 @@ Documentation paths should refer to content under `../coder/docs/`. Image assets
6678

6779
## Getting Started
6880

69-
1. **Clone the repo locally** (or fork it for sandboxed edits):
70-
```bash
71-
git clone git@github.com:yourusername/coder-docs-writing.git ~/.coder-docs-writing
72-
```
81+
1. Clone the repo locally (or fork it for sandboxed edits):
82+
83+
```bash
84+
git clone git@github.com:yourusername/coder-docs-writing.git ~/.coder-docs-writing
85+
```
7386

74-
2. **(Optional) Create a symlink for convenience**:
75-
```bash
76-
ln -s ~/.coder-docs-writing ~/Documents/coder-docs-writing
77-
```
87+
1. Review or contribute to the shared files:
7888

79-
3. **(Optional) Create a shell alias for quick access**:
80-
```bash
81-
alias dockb='cd ~/.coder-docs-writing && nvim'
82-
```
89+
1. Use `style-guide.md` to guide any edits or submissions.
8390

84-
4. **Review or contribute to the shared files**:
85-
- Use `style-guide.md` to guide any edits or submissions.
86-
- Use `architecture-notes.md` to share system behavior or insights.
87-
- Use `ai-project-notes.md` for project context and session memory.
88-
- Use `claude-code-config.md` to align Claude’s output with established documentation expectations and Git/image handling workflows.
91+
1. Use `architecture-notes.md` to share system behavior or insights.
8992

90-
5. **For AI usage**, upload or reference the relevant files during prompts to ChatGPT or Claude.
93+
1. Use `ai-project-notes.md` for project context and session memory.
94+
95+
1. Use `claude-code-config.md` to align Claude’s output with established documentation expectations and Git/image handling workflows.
96+
97+
1. For AI usage, upload or reference the relevant files during prompts to ChatGPT or Claude.
9198

9299
---
93100

@@ -96,25 +103,32 @@ Documentation paths should refer to content under `../coder/docs/`. Image assets
96103
Say you're documenting a new Coder feature and want to ensure style consistency:
97104
98105
1. Upload `style-guide.md` and `architecture-notes.md` to your LLM session.
99-
2. Paste in raw markdown from a WIP doc.
100-
3. Prompt: _"Review this content using my style guide and Coder architecture notes."_
106+
107+
1. Paste in raw markdown from a WIP doc.
108+
109+
1. Prompt: _"Review this content using my style guide and Coder architecture notes."_
101110
102111
Or:
103112
104-
4. After wrapping a long LLM session:
105-
Prompt: _"Summarize what we just discussed and add it to `ai-project-notes.md` in today's date section."_
113+
1. After wrapping a long LLM session:
114+
115+
Prompt: _"Summarize what we just discussed and add it to `ai-project-notes.md` in today's date section."_
106116
107117
Coworkers can also use the same context files when jumping in to help maintain consistency.
108118
109119
---
110120
111121
## Next Steps
112122
113-
- ✅ Populate `style-guide.md` and `doc-template.md` based on current habits
114-
- ✅ Start using `ai-project-notes.md` as a running journal with daily notes
115-
- 🔁 Invite team members to contribute and update key files collaboratively
116-
- ⏳ Optionally script or automate note updates from PRs, commits, or AI output
117-
- 📎 Claude config now reflects all previous Claude-specific guidance (including Git/image behavior and prompt strategy)
123+
1. Populate `style-guide.md` and `doc-template.md` based on current habits
124+
125+
1. Start using `ai-project-notes.md` as a running journal with daily notes
126+
127+
1. Invite team members to contribute and update key files collaboratively
128+
129+
1. Optionally script or automate note updates from PRs, commits, or AI output
130+
131+
1. Claude config now reflects all previous Claude-specific guidance (including Git/image behavior and prompt strategy)
118132
119133
---
120134
@@ -123,22 +137,34 @@ Coworkers can also use the same context files when jumping in to help maintain c
123137
This repo is meant to be shared across documentation contributors and AI assistants. Please follow these guidelines when editing or proposing changes:
124138
125139
### General Rules
126-
- **Do not use emojis** in headings or list items
127-
- **Use relative paths** for internal links and image references
128-
- All code blocks should have a language identifier (e.g., `bash`, `json`, `md`)
129-
- Refer to `style-guide.md` before formatting or revising content
140+
141+
1. **Do not use emojis** in headings or list items
142+
143+
1. **Use relative paths** for internal links and image references
144+
145+
1. All code blocks should have a language identifier (e.g., `bash`, `json`, `md`)
146+
147+
1. Refer to `style-guide.md` before formatting or revising content
130148
131149
### File Guidelines
132-
- `style-guide.md`: Contribute formatting rules, tone notes, or markdown patterns
133-
- `architecture-notes.md`: Document internal behavior of the Coder system
134-
- `ai-project-notes.md`: Add time-stamped entries summarizing decisions, quirks, or updates
135-
- `templates/`: Extend with new skeletons or reusable snippets
136-
- `integration/`: Do not remove AI configuration files — update with care
150+
151+
1. `style-guide.md`: Contribute formatting rules, tone notes, or markdown patterns
152+
153+
1. `architecture-notes.md`: Document internal behavior of the Coder system
154+
155+
1. `ai-project-notes.md`: Add time-stamped entries summarizing decisions, quirks, or updates
156+
157+
1. `templates/`: Extend with new skeletons or reusable snippets
158+
159+
1. `integration/`: Do not remove AI configuration files — update with care
137160
138161
### Git Practices
139-
- Always branch from `main`
140-
- Use descriptive branch names (e.g., `fix/agent-notes`, `feat/add-provisioning-snippets`)
141-
- Keep PRs focused and small when possible
162+
163+
1. Always branch from `main`
164+
165+
1. Use descriptive branch names (e.g., `fix/agent-notes`, `feat/add-provisioning-snippets`)
166+
167+
1. Keep PRs focused and small when possible
142168
143169
This keeps the repo clean, traceable, and AI-friendly.
144170

0 commit comments

Comments
 (0)