Skip to content

docs: improve README #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# MinionCodeAgent

An enhanced AI code assistant built on the Minion framework, pre-configured with rich development tools, optimized for code development tasks.
Expand Down Expand Up @@ -103,14 +105,17 @@ mcode model claude-3-5-sonnet
mcode model --clear
```

**

@cubic-dev-ai cubic-dev-ai Bot Aug 28, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3: The two added lines ** and a bare code fence ``` break Markdown rendering. ** opens a bold span that is never closed, and the ``` opens a code block that runs until the next fence, so the following **Model Priority:** list, the ACP section, and later content render as code/inline styling instead of normal Markdown. Remove both stray lines so the content between the previous ```bash block close and **Model Priority:** renders correctly.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 108:

<comment>The two added lines `**` and a bare code fence ` ``` ` break Markdown rendering. `**` opens a bold span that is never closed, and the ` ``` ` opens a code block that runs until the next fence, so the following `**Model Priority:**` list, the ACP section, and later content render as code/inline styling instead of normal Markdown. Remove both stray lines so the content between the previous ` ```bash ` block close and `**Model Priority:**` renders correctly.</comment>

<file context>
@@ -103,14 +105,17 @@ mcode model claude-3-5-sonnet
 mcode model --clear

+**
+```
+
</file context>


</details>

```

**Model Priority:**
1. CLI `--model` argument (highest priority)
2. Config file `~/.minion/minion-code.json`
3. Built-in default (lowest priority)

### ACP Protocol Support

MinionCodeAgent supports the [ACP (Agent Communication Protocol)](https://agentcommunicationprotocol.dev/) protocol, enabling integration with ACP-compatible clients like Zed editor.
MinionCodeAgent supports the [ACP (Agent Client Protocol)](https://agentcommunicationprotocol.dev/) protocol, enabling integration with ACP-compatible clients like Zed editor.

```bash
# Start ACP server (stdio mode)
Expand Down Expand Up @@ -444,4 +449,4 @@ Issues and Pull Requests are welcome to improve this project!

## License

MIT License
MIT License