Initial dotfiles repo for Mac and Linux
This commit is contained in:
@@ -0,0 +1,28 @@
|
||||
# AI Instructions / Rules System
|
||||
|
||||
This directory contains single-source-of-truth instructions that are shared between **Claude Code** and **Cursor IDE**.
|
||||
|
||||
## How It Works
|
||||
|
||||
```
|
||||
ai-instructions/*.md (SOURCE OF TRUTH)
|
||||
↓
|
||||
├──> claude/.claude/rules/*.md (symlinks for Claude Code)
|
||||
└──> cursor/.cursor/rules/*.md (symlinks for Cursor IDE)
|
||||
```
|
||||
|
||||
### During Installation
|
||||
|
||||
When you run `install.sh` (or when a Coder devbox starts):
|
||||
|
||||
1. **Directories created**: `claude/.claude/rules` and `cursor/.cursor/rules` are created.
|
||||
2. **Rules generated**: The `generate_rules` function in `install.sh` symlinks `ai-instructions/*.md` → `claude/.claude/rules/*.md` and `cursor/.cursor/rules/*.md`.
|
||||
3. **Stow creates symlinks**:
|
||||
- `claude/.claude/*` → `~/.claude/*`
|
||||
- `cursor/.cursor/*` → `~/.cursor/*`
|
||||
|
||||
### Result
|
||||
|
||||
Both IDEs load the same instructions:
|
||||
- **Claude Code**: Reads `~/.claude/CLAUDE.md` + `~/.claude/rules/*.md`
|
||||
- **Cursor IDE**: Reads `~/.cursor/rules/*.md`
|
||||
@@ -0,0 +1,28 @@
|
||||
# Slack Message Formatting Guide
|
||||
|
||||
When sending Slack messages via MCP tools, use **standard Markdown** formatting.
|
||||
|
||||
## What Works
|
||||
|
||||
- `**bold**` and `*italic*`, `_italic_`, `~~strikethrough~~`, `` `inline code` ``
|
||||
- Code blocks with triple backticks (with or without language tag)
|
||||
- Unordered lists with `-` dashes (nested lists with indentation work)
|
||||
- Numbered lists with `1.` style
|
||||
- Links with `[text](url)` — raw URLs are also auto-unfurled
|
||||
- Blockquotes with `>`
|
||||
- Blank lines between paragraphs
|
||||
|
||||
## What Does NOT Work (Avoid)
|
||||
|
||||
- **Tables** — render as garbled text. Use a Google Doc, Slack canvas, or a simple list instead.
|
||||
- **Horizontal rules** (`---`, `***`) — not rendered. Use blank lines for separation.
|
||||
- **Headings** (`#`, `##`) — show as plain text with `#` symbols. Use `**bold text**` on its own line instead.
|
||||
- **HTML tags** — render as plain text. Use Markdown equivalents.
|
||||
- **Images** (``) — no inline display. Alt text shows as a clickable link. Use sparingly and only when necessary.
|
||||
|
||||
## Key Rules
|
||||
|
||||
- Use standard Markdown `[text](url)` — NOT Slack mrkdwn `<url|text>`
|
||||
- Use `-` dashes for bullets — NOT `•` unicode bullets
|
||||
- Use `**bold**` on its own line for section headers — NOT `#` headings
|
||||
- Use blank lines for separation — NOT horizontal rules
|
||||
Reference in New Issue
Block a user