Skip to content

Commit a619eea

Browse files
authored
Merge pull request #85 from nikomatsakis/main
update deps, improve docs
2 parents 653f8a7 + 55069fc commit a619eea

File tree

15 files changed

+297
-135
lines changed

15 files changed

+297
-135
lines changed

Cargo.lock

Lines changed: 104 additions & 97 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

md/SUMMARY.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@
1212

1313
- [Introduction](./introduction.md)
1414
- [About](./about.md)
15-
- [Rust Crate Sources Tool](./rust-expertise.md)
16-
- [Rich Collaboration](./rich-collaboration.md)
15+
- [How it works](./how-it-works.md)
16+
- [How to install](./install.md)
17+
- [VSCode](./install-vscode.md)
18+
- [Other editors](./install-other.md)
19+
- [How to contribute](./contribute.md)
1720

1821
# Design and implementation
1922

md/about.md

Lines changed: 24 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,36 @@
1-
# About Symposium
1+
# What we want to achieve
22

3-
Symposium is a set of components that make AI agents work better. These components are compatible with any ACP-based editing system, including Zed, VSCode (with our plugin), and IntelliJ and NeoVim (coming soon).
3+
You fire up your agent of choice through Symposium. It has a more collaborative style, remembers the way you like to work. It knows about your dependencies and incorporates advice supplied by the crate authors on how best to use them. You can install extensions that transform the agent — new skills, new MCP servers, or more advanced capabilities like custom GUI interfaces and new ways of working.
44

5-
We focus on three areas:
5+
## AI the Rust Way
66

7-
<div class="tenets-grid">
7+
Symposium brings Rust's design philosophy to AI-assisted development.
88

9-
<div class="tenet-section">
10-
<h2>Rust Expertise</h2>
11-
<p>Built-in capabilities for understanding Rust language, errors, and idioms.</p>
12-
<ul class="tenet-examples">
13-
<li class="works"><a href="./rust-expertise.md">rust-crate-sources tool</a></li>
14-
<li class="coming-soon">IDE operations</li>
15-
<li class="coming-soon">Error explanations</li>
16-
</ul>
17-
</div>
9+
<div class="pillars">
1810

19-
<div class="tenet-section">
20-
<h2>Ecosystem-Powered Knowledge</h2>
21-
<p>Crate authors provide specialized AI tooling through Cargo.toml metadata, bringing domain knowledge directly to the agent.</p>
22-
<ul class="tenet-examples">
23-
<li class="coming-soon">Crate-provided skills, context, and capabilities</li>
24-
</ul>
25-
</div>
11+
<div class="pillar">
12+
<h3>Leverage the wisdom of <s>the crowd</s> crates.io</h3>
13+
14+
Rust embraces a small stdlib and a rich crate ecosystem. Symposium brings that philosophy to AI: your dependencies can teach your agent how to use them. Add a crate, and your agent learns its idioms, patterns, and best practices.
15+
16+
Beyond crate knowledge, we want to make it easy to publish agent extensions that others can try out and adopt just by adding a line to their configuration — the same way you'd add a dependency to `Cargo.toml`.
2617

27-
<div class="tenet-section">
28-
<h2>Rich Collaboration</h2>
29-
<p>Interactive patterns for human-AI partnership beyond simple text exchanges.</p>
30-
<ul class="tenet-examples">
31-
<li class="coming-soon"><a href="./rich-collaboration.md">Sparkle collaborative patterns</a></li>
32-
<li class="coming-soon">Walkthroughs</li>
33-
<li class="coming-soon">Taskspaces</li>
34-
</ul>
3518
</div>
3619

20+
<div class="pillar">
21+
<h3>Stability without stagnation</h3>
22+
23+
Rust evolves quickly and agents' training data goes stale. Symposium helps your agent take advantage of the latest Rust features and learn how to use new or private crates — things not found in its training data.
24+
25+
We provide guides and context that keep models up-to-date, helping them write idiomatic Rust rather than JavaScript-in-disguise.
26+
3727
</div>
3828

39-
## Open Source Community
29+
<div class="pillar">
30+
<h3>Open, portable, and vendor neutral</h3>
4031

41-
Symposium is an open-source project and we are actively soliciting [contributors](./contribute.md). We welcome users as well, but given the exploratory nature of Symposium, expect frequent changes. Currently, the only way to install Symposium is from source.
32+
Open source tools that everyone can improve. Build extensions once, use them with any ACP-compatible agent. No vendor lock-in.
4233

43-
We maintain a [code of conduct](https://github.com/symposium-dev/symposium/blob/main/CODE_OF_CONDUCT.md) and operate as an independent community focused on exploring what AI has to offer for software development.
34+
</div>
35+
36+
</div>

md/artwork/logos/rustrover.png

475 KB
Loading

md/artwork/logos/vscode.png

194 KB
Loading

md/artwork/logos/zed.png

442 KB
Loading

md/contribute.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# How to contribute
2+
3+
Symposium is an open-source project in active development. We're iterating heavily and welcome collaborators who want to shape where this goes.
4+
5+
## Come chat with us
6+
7+
The best way to get involved is to join us on [Zulip](https://symposium.zulipchat.com/). We use it for design discussions, coordination, and general conversation about AI-assisted development.
8+
9+
Drop in, say hello, and tell us what you're interested in working on.
10+
11+
## The codebase
12+
13+
The code lives at [github.com/symposium-dev/symposium](https://github.com/symposium-dev/symposium).
14+
15+
We maintain a [code of conduct](https://github.com/symposium-dev/symposium/blob/main/CODE_OF_CONDUCT.md) and operate as an independent community exploring what AI has to offer for software development.
16+
17+
## Expectations
18+
19+
Given the exploratory nature of Symposium, expect frequent changes. APIs are unstable, and we're still figuring out the right abstractions. This is a good time to contribute if you want to influence the direction — but be prepared for things to shift as we learn.

md/how-it-works.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# How it works
2+
3+
Symposium is built on [ACP](https://github.com/anthropics/agent-client-protocol)'s proxy architecture. A proxy sits between your editor and your agent, observing and augmenting the conversation. This position lets it do things MCP servers can't:
4+
5+
- Intercept and modify agent behavior
6+
- Inject context based on your project's dependencies
7+
- Coordinate multi-step workflows
8+
- Contribute UI components to the editor
9+
10+
## Current components
11+
12+
### Ferris
13+
14+
[Ferris](https://github.com/symposium-dev/ferris) is an MCP server that gives agents access to Rust-specific patterns and information.
15+
16+
### symposium-cargo
17+
18+
[symposium-cargo](https://github.com/symposium-dev/symposium-cargo) wraps the `cargo` command, capturing build output and providing it to your agent in a structured format. This gives agents better insight into compilation errors, warnings, and test results.
19+
20+
### Sparkle
21+
22+
[Sparkle](https://symposium-dev.github.io/sparkle/) helps agents develop collaborative working patterns. It helps agents remember how you like to work, maintain context across sessions, and engage more naturally in back-and-forth problem solving.
23+
24+
## What we're experimenting with
25+
26+
- **IDE operations**: Bringing language server capabilities (go-to-definition, find references, refactoring) directly to agents
27+
- **Error explanations**: Rich, context-aware explanations of Rust compiler errors
28+
- **Crate-provided tooling**: Allowing crate authors to ship agent capabilities alongside their libraries
29+
- **Walkthroughs**: Interactive guided explorations of code and concepts
30+
- **Taskspaces**: Isolated working contexts for complex multi-step tasks

md/install-other.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Zed, RustRover, Neovim, and other editors
2+
3+
For ACP-compatible editors, install the Symposium agent binary:
4+
5+
```bash
6+
cargo binstall symposium-acp-agent
7+
```
8+
9+
Then configure your editor to use `symposium-acp-agent` as the agent command, passing your preferred downstream agent. For example, with Claude Code:
10+
11+
```bash
12+
symposium-acp-agent -- claude-code --acp
13+
```
14+
15+
Or with Zed's Claude integration:
16+
17+
```bash
18+
symposium-acp-agent -- npx -y @anthropic-ai/claude-code-zed
19+
```
20+
21+
The `--` separates Symposium's arguments from the downstream agent command.

md/install-vscode.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# VSCode and VSCode-based editors
2+
3+
Install the Symposium extension from:
4+
5+
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=symposium.symposium)
6+
- [Open VSX Registry](https://open-vsx.org/extension/symposium/symposium)
7+
8+
## Getting started
9+
10+
Once installed, you'll see the Symposium icon in the Activity Bar on the left side of your editor:
11+
12+
<img src="./artwork/ferris-in-a-robe-thick.svg" alt="Symposium icon" width="48"/>
13+
14+
Click the icon to open the Symposium panel. From there you can select your agent and start a chat session.

0 commit comments

Comments
 (0)