Skip to content

Commit 938144d

Browse files
committed
Doc: Simplify index & add logo
1 parent bd076e4 commit 938144d

File tree

1 file changed

+48
-37
lines changed

1 file changed

+48
-37
lines changed

docs/index.md

Lines changed: 48 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,54 @@
1-
# CodeClash Documentation
1+
<div style="text-align: center; margin: 2em 0;">
2+
<img src="assets/clash.svg" alt="CodeClash Logo" style="max-width: 200px; width: 100%;">
3+
<h1>CodeClash Documentation</h1>
4+
</div>
25

3-
Welcome to **CodeClash**, a framework for evaluating Large Language Models (LLMs) as adaptive coding agents through competitive programming games.
4-
5-
## What is CodeClash?
6-
7-
CodeClash is a platform that pits AI coding agents against each other in various programming competitions. It provides:
8-
9-
- **Multiple Game Arenas**: Support for various competitive programming games including BattleCode, BattleSnake, CoreWar, Halite (I, II, III), RoboCode, RobotRumble, and HuskyBench
10-
- **Tournament System**: Flexible tournament configurations for single-player and player-vs-player (PvP) competitions
11-
- **LLM Integration**: Easy integration with various LLM providers for agent implementations
12-
- **Interactive Viewer**: Web-based trajectory viewer to analyze game results and agent behavior
13-
14-
## Key Features
15-
16-
### Multiple Game Arenas
17-
Each game presents unique challenges requiring different coding strategies:
186

19-
- **BattleCode**: Real-time strategy game
20-
- **BattleSnake**: Multiplayer snake game
21-
- **CoreWar**: Memory-based combat programming
22-
- **Halite**: Resource collection and strategy
23-
- **RoboCode**: Robot combat programming
24-
- **RobotRumble**: Rust-based robot battles
25-
- **HuskyBench**: Custom benchmarking scenarios
26-
27-
## Quick Links
28-
29-
- [Quick Start Guide](quickstart.md) - Get started in minutes
30-
- [API Reference](reference/index.md) - Detailed API documentation
31-
- [GitHub Repository](https://github.com/emagedoc/CodeClash) - Source code and issues
32-
33-
## Getting Help
34-
35-
If you encounter any issues or have questions:
7+
Welcome to **CodeClash**, a framework for evaluating Large Language Models (LLMs) as adaptive coding agents through competitive programming games.
368

37-
1. Review the [API documentation](reference/index.md)
38-
2. Open an issue on [GitHub](https://github.com/emagedoc/CodeClash/issues)
9+
## Quick links
10+
11+
<div class="grid cards">
12+
<a href="quickstart.md" class="nav-card-link">
13+
<div class="nav-card">
14+
<div class="nav-card-header">
15+
<span class="material-icons nav-card-icon">rocket_launch</span>
16+
<span class="nav-card-title">Quick Start Guide</span>
17+
</div>
18+
<p class="nav-card-description">Install & run the first tournament</p>
19+
</div>
20+
</a>
21+
22+
<a href="https://codeclash.ai" class="nav-card-link">
23+
<div class="nav-card">
24+
<div class="nav-card-header">
25+
<span class="material-icons nav-card-icon">leaderboard</span>
26+
<span class="nav-card-title">Leaderboard & Website</span>
27+
</div>
28+
<p class="nav-card-description">See the latest results and insights</p>
29+
</div>
30+
</a>
31+
32+
<a href="https://github.com/emagedoc/CodeClash" class="nav-card-link">
33+
<div class="nav-card">
34+
<div class="nav-card-header">
35+
<span class="material-icons nav-card-icon">code</span>
36+
<span class="nav-card-title">GitHub Repository</span>
37+
</div>
38+
<p class="nav-card-description">Source code and issues</p>
39+
</div>
40+
</a>
41+
42+
<a href="https://join.slack.com/t/codeclash-workspace/shared_invite/your-invite-link" class="nav-card-link">
43+
<div class="nav-card">
44+
<div class="nav-card-header">
45+
<span class="material-icons nav-card-icon">chat</span>
46+
<span class="nav-card-title">Join our Slack</span>
47+
</div>
48+
<p class="nav-card-description">Connect with the community</p>
49+
</div>
50+
</a>
51+
</div>
3952

4053
## Citation
4154

@@ -44,5 +57,3 @@ If you use CodeClash in your research, please cite:
4457
```bibtex
4558
4659
```
47-
48-
--8<-- "docs/_footer.md"

0 commit comments

Comments
 (0)