98 lines
2.2 KiB
Markdown
98 lines
2.2 KiB
Markdown
# Inline Edits Syntax
|
|
|
|
## Purpose
|
|
|
|
Human can add quick drafts and notes directly in article text using square brackets. Agents process these and integrate them into the final article.
|
|
|
|
## Syntax: `[text]`
|
|
|
|
Square brackets contain human-written content that needs processing:
|
|
|
|
```markdown
|
|
[claude use editing tool to add this. TODO: insert the correct tool name]
|
|
```
|
|
|
|
**Becomes:**
|
|
```markdown
|
|
Claude uses `str_replace` to append content.
|
|
```
|
|
|
|
The agent:
|
|
- Rewrites the text in article's tone and style
|
|
- Translates to English if needed
|
|
- Completes any TODO instructions inside
|
|
- Applies proper formatting
|
|
- Removes the brackets
|
|
|
|
## Examples
|
|
|
|
**Input:**
|
|
```markdown
|
|
[тут надо объяснить что файл создается в home директории. TODO: уточни точный путь]
|
|
```
|
|
|
|
**Output:**
|
|
```markdown
|
|
The file is created in Claude's home directory at `/home/claude/`.
|
|
```
|
|
|
|
---
|
|
|
|
**Input:**
|
|
```markdown
|
|
[this is important for understanding. the sandbox resets after timeout. TODO: check if 5 minutes is correct timeout]
|
|
```
|
|
|
|
**Output:**
|
|
```markdown
|
|
This is important to understand: the sandbox environment resets after approximately 5 minutes of inactivity.
|
|
```
|
|
|
|
---
|
|
|
|
**Input:**
|
|
```markdown
|
|
The key directories are:
|
|
[TODO: add table with paths and their descriptions]
|
|
```
|
|
|
|
**Output:**
|
|
```markdown
|
|
The key directories are:
|
|
|
|
| Path | Description |
|
|
|------|-------------|
|
|
| /home/claude/ | Working directory, volatile |
|
|
| /mnt/user-data/outputs/ | Persistent, visible in sidebar |
|
|
| /mnt/user-data/uploads/ | Your uploaded files |
|
|
```
|
|
|
|
## Command: /apply
|
|
|
|
For @writer:
|
|
|
|
```
|
|
/apply
|
|
```
|
|
|
|
**Action:**
|
|
1. Re-read entire `text.md`
|
|
2. Find all `[bracketed content]`
|
|
3. Process each: rewrite, translate, complete TODOs, format
|
|
4. Remove brackets
|
|
5. Log changes in `log-chat.md`
|
|
|
|
## Agent Responsibilities
|
|
|
|
| Agent | Role |
|
|
|-------|------|
|
|
| @writer | Process all bracketed content with `/apply` |
|
|
| @editor | **Verify no unprocessed brackets remain** — final text must be clean |
|
|
| Others | May process if within scope, or flag for @writer |
|
|
|
|
**Critical for @editor:** Before approving for publication, confirm the text contains zero `[brackets]`. Any remaining brackets = not ready for publish.
|
|
|
|
---
|
|
|
|
*Updated: 2025-01-07*
|