|
96 | 96 | <div data-md-component="skip"> |
97 | 97 |
|
98 | 98 |
|
99 | | - <a href="#codeclash-documentation" class="md-skip"> |
| 99 | + <a href="#quick-links" class="md-skip"> |
100 | 100 | Skip to content |
101 | 101 | </a> |
102 | 102 |
|
|
1195 | 1195 |
|
1196 | 1196 |
|
1197 | 1197 |
|
1198 | | - |
1199 | | - |
1200 | 1198 |
|
1201 | 1199 | <label class="md-nav__title" for="__toc"> |
1202 | 1200 | <span class="md-nav__icon md-icon"></span> |
1203 | 1201 | Table of contents |
1204 | 1202 | </label> |
1205 | 1203 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> |
1206 | 1204 |
|
1207 | | - <li class="md-nav__item"> |
1208 | | - <a href="#what-is-codeclash" class="md-nav__link"> |
1209 | | - <span class="md-ellipsis"> |
1210 | | - What is CodeClash? |
1211 | | - </span> |
1212 | | - </a> |
1213 | | - |
1214 | | -</li> |
1215 | | - |
1216 | | - <li class="md-nav__item"> |
1217 | | - <a href="#key-features" class="md-nav__link"> |
1218 | | - <span class="md-ellipsis"> |
1219 | | - Key Features |
1220 | | - </span> |
1221 | | - </a> |
1222 | | - |
1223 | | - <nav class="md-nav" aria-label="Key Features"> |
1224 | | - <ul class="md-nav__list"> |
1225 | | - |
1226 | | - <li class="md-nav__item"> |
1227 | | - <a href="#multiple-game-arenas" class="md-nav__link"> |
1228 | | - <span class="md-ellipsis"> |
1229 | | - Multiple Game Arenas |
1230 | | - </span> |
1231 | | - </a> |
1232 | | - |
1233 | | -</li> |
1234 | | - |
1235 | | - </ul> |
1236 | | - </nav> |
1237 | | - |
1238 | | -</li> |
1239 | | - |
1240 | 1205 | <li class="md-nav__item"> |
1241 | 1206 | <a href="#quick-links" class="md-nav__link"> |
1242 | 1207 | <span class="md-ellipsis"> |
1243 | | - Quick Links |
1244 | | - </span> |
1245 | | - </a> |
1246 | | - |
1247 | | -</li> |
1248 | | - |
1249 | | - <li class="md-nav__item"> |
1250 | | - <a href="#getting-help" class="md-nav__link"> |
1251 | | - <span class="md-ellipsis"> |
1252 | | - Getting Help |
| 1208 | + Quick links |
1253 | 1209 | </span> |
1254 | 1210 | </a> |
1255 | 1211 |
|
|
1288 | 1244 |
|
1289 | 1245 |
|
1290 | 1246 |
|
1291 | | -<h1 id="codeclash-documentation">CodeClash Documentation</h1> |
| 1247 | +<div style="text-align: center; margin: 2em 0;"> |
| 1248 | + <img src="assets/clash.svg" alt="CodeClash Logo" style="max-width: 200px; width: 100%;"> |
| 1249 | +<h1>CodeClash Documentation</h1> |
| 1250 | +</div> |
| 1251 | + |
1292 | 1252 | <p>Welcome to <strong>CodeClash</strong>, a framework for evaluating Large Language Models (LLMs) as adaptive coding agents through competitive programming games.</p> |
1293 | | -<h2 id="what-is-codeclash">What is CodeClash?</h2> |
1294 | | -<p>CodeClash is a platform that pits AI coding agents against each other in various programming competitions. It provides:</p> |
1295 | | -<ul> |
1296 | | -<li><strong>Multiple Game Arenas</strong>: Support for various competitive programming games including BattleCode, BattleSnake, CoreWar, Halite (I, II, III), RoboCode, RobotRumble, and HuskyBench</li> |
1297 | | -<li><strong>Tournament System</strong>: Flexible tournament configurations for single-player and player-vs-player (PvP) competitions</li> |
1298 | | -<li><strong>LLM Integration</strong>: Easy integration with various LLM providers for agent implementations</li> |
1299 | | -<li><strong>Interactive Viewer</strong>: Web-based trajectory viewer to analyze game results and agent behavior</li> |
1300 | | -</ul> |
1301 | | -<h2 id="key-features">Key Features</h2> |
1302 | | -<h3 id="multiple-game-arenas">Multiple Game Arenas</h3> |
1303 | | -<p>Each game presents unique challenges requiring different coding strategies:</p> |
1304 | | -<ul> |
1305 | | -<li><strong>BattleCode</strong>: Real-time strategy game</li> |
1306 | | -<li><strong>BattleSnake</strong>: Multiplayer snake game</li> |
1307 | | -<li><strong>CoreWar</strong>: Memory-based combat programming</li> |
1308 | | -<li><strong>Halite</strong>: Resource collection and strategy</li> |
1309 | | -<li><strong>RoboCode</strong>: Robot combat programming</li> |
1310 | | -<li><strong>RobotRumble</strong>: Rust-based robot battles</li> |
1311 | | -<li><strong>HuskyBench</strong>: Custom benchmarking scenarios</li> |
1312 | | -</ul> |
1313 | | -<h2 id="quick-links">Quick Links</h2> |
1314 | | -<ul> |
1315 | | -<li><a href="quickstart/">Quick Start Guide</a> - Get started in minutes</li> |
1316 | | -<li><a href="reference/">API Reference</a> - Detailed API documentation</li> |
1317 | | -<li><a href="https://github.com/emagedoc/CodeClash">GitHub Repository</a> - Source code and issues</li> |
1318 | | -</ul> |
1319 | | -<h2 id="getting-help">Getting Help</h2> |
1320 | | -<p>If you encounter any issues or have questions:</p> |
1321 | | -<ol> |
1322 | | -<li>Review the <a href="reference/">API documentation</a></li> |
1323 | | -<li>Open an issue on <a href="https://github.com/emagedoc/CodeClash/issues">GitHub</a></li> |
1324 | | -</ol> |
1325 | | -<h2 id="citation">Citation</h2> |
1326 | | -<p>If you use CodeClash in your research, please cite:</p> |
1327 | | -<div class="highlight"><pre><span></span><code> |
1328 | | -</code></pre></div> |
| 1253 | +<h2 id="quick-links">Quick links</h2> |
1329 | 1254 | <div class="grid cards"> |
1330 | | - <a href="https://github.com/emagedoc/CodeClash/issues/new" class="nav-card-link"> |
| 1255 | + <a href="quickstart.md" class="nav-card-link"> |
1331 | 1256 | <div class="nav-card"> |
1332 | 1257 | <div class="nav-card-header"> |
1333 | | - <span class="material-icons nav-card-icon">bug_report</span> |
1334 | | - <span class="nav-card-title">Something broken/unclear?</span> |
| 1258 | + <span class="material-icons nav-card-icon">rocket_launch</span> |
| 1259 | + <span class="nav-card-title">Quick Start Guide</span> |
1335 | 1260 | </div> |
1336 | | - <p class="nav-card-description">Open an issue on GitHub!</p> |
| 1261 | + <p class="nav-card-description">Install & run the first tournament</p> |
| 1262 | + </div> |
| 1263 | + </a> |
| 1264 | + |
| 1265 | + <a href="https://codeclash.ai" class="nav-card-link"> |
| 1266 | + <div class="nav-card"> |
| 1267 | + <div class="nav-card-header"> |
| 1268 | + <span class="material-icons nav-card-icon">leaderboard</span> |
| 1269 | + <span class="nav-card-title">Leaderboard & Website</span> |
| 1270 | + </div> |
| 1271 | + <p class="nav-card-description">See the latest results and insights</p> |
| 1272 | + </div> |
| 1273 | + </a> |
| 1274 | + |
| 1275 | + <a href="https://github.com/emagedoc/CodeClash" class="nav-card-link"> |
| 1276 | + <div class="nav-card"> |
| 1277 | + <div class="nav-card-header"> |
| 1278 | + <span class="material-icons nav-card-icon">code</span> |
| 1279 | + <span class="nav-card-title">GitHub Repository</span> |
| 1280 | + </div> |
| 1281 | + <p class="nav-card-description">Source code and issues</p> |
1337 | 1282 | </div> |
1338 | 1283 | </a> |
1339 | 1284 |
|
1340 | 1285 | <a href="https://join.slack.com/t/codeclash-workspace/shared_invite/your-invite-link" class="nav-card-link"> |
1341 | 1286 | <div class="nav-card"> |
1342 | 1287 | <div class="nav-card-header"> |
1343 | | - <span class="material-icons nav-card-icon">help</span> |
1344 | | - <span class="nav-card-title">Open-ended discussions</span> |
| 1288 | + <span class="material-icons nav-card-icon">chat</span> |
| 1289 | + <span class="nav-card-title">Join our Slack</span> |
1345 | 1290 | </div> |
1346 | | - <p class="nav-card-description">Join our Slack!</p> |
| 1291 | + <p class="nav-card-description">Connect with the community</p> |
1347 | 1292 | </div> |
1348 | 1293 | </a> |
1349 | 1294 | </div> |
1350 | 1295 |
|
| 1296 | +<h2 id="citation">Citation</h2> |
| 1297 | +<p>If you use CodeClash in your research, please cite:</p> |
| 1298 | +<div class="highlight"><pre><span></span><code> |
| 1299 | +</code></pre></div> |
| 1300 | + |
1351 | 1301 |
|
1352 | 1302 |
|
1353 | 1303 |
|
|
0 commit comments