Skip to content

SWE-agent takes a GitHub issue and tries to automatically fix it, using your LM of choice. It can also be employed for offensive cybersecurity or competitive coding challenges. [NeurIPS 2024]

Doc: Use navigation cards & link to slack (#1270)

Kilian Lieret9a8f53c00922
diff --git a/docs/_footer.md b/docs/_footer.md
index 03b78d49..1720aa3e 100644
--- a/docs/_footer.md
+++ b/docs/_footer.md
@@ -1,9 +1,21 @@
-<div class="grid cards" markdown>
-
-- :material-bug:{ .lg .middle } __Something broken?__
- [:octicons-arrow-right-24: Report bug](https://github.com/SWE-agent/SWE-agent/issues/new?template=bug_report.yml)
-
-- :material-help:{ .lg .middle } __Something unclear?__
- [:octicons-arrow-right-24: Ask question](https://github.com/SWE-agent/SWE-agent/issues/new?template=question.yml)
+<div class="grid cards">
+ <a href="https://github.com/SWE-agent/SWE-agent/issues/new" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">bug_report</span>
+ <span class="nav-card-title">Something broken/unclear?</span>
+ </div>
+ <p class="nav-card-description">Open an issue on GitHub!</p>
+ </div>
+ </a>
+ <a href="https://join.slack.com/t/swe-bench/shared_invite/zt-36pj9bu5s-o3_yXPZbaH2wVnxnss1EkQ" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">help</span>
+ <span class="nav-card-title">Open-ended discussions</span>
+ </div>
+ <p class="nav-card-description">Join our Slack!</p>
+ </div>
+ </a>
</div>
diff --git a/docs/assets/navigation_cards.css b/docs/assets/navigation_cards.css
new file mode 100644
index 00000000..1e032f1f
--- /dev/null
+++ b/docs/assets/navigation_cards.css
@@ -0,0 +1,43 @@
+/* Navigation cards styling */
+.nav-card-link {
+ text-decoration: none;
+ color: inherit;
+ display: block;
+}
+
+.nav-card {
+ padding: 1rem;
+ border: 1px solid var(--md-default-fg-color--lighter);
+ border-radius: 0.5rem;
+ transition:
+ box-shadow 0.2s,
+ transform 0.2s;
+}
+
+.nav-card:hover {
+ box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
+ transform: translateY(-2px);
+}
+
+.nav-card-header {
+ display: flex;
+ align-items: center;
+ margin-bottom: 0.5rem;
+}
+
+.nav-card-icon {
+ margin-right: 0.5rem;
+ font-size: 1.2rem;
+ color: var(--md-default-fg-color);
+}
+
+.nav-card-description {
+ margin: 0;
+ color: var(--md-default-fg-color--light);
+}
+
+.nav-card-title {
+ margin: 0;
+ font-weight: bold;
+ color: var(--md-default-fg-color);
+}
diff --git a/docs/dev/contribute.md b/docs/dev/contribute.md
index aef18a3f..0fed7b3b 100644
--- a/docs/dev/contribute.md
+++ b/docs/dev/contribute.md
@@ -133,16 +133,15 @@ and point your browser to port 8000 or click one of the links in the output.
## Diving into the code
-<div class="grid cards" markdown>
-
-- :material-cog:{ .lg .middle } __Code structure and reference__
-
- ---
-
- Read the reference for more information on our code.
-
- [:octicons-arrow-right-24: Read more](../reference/index.md)
-
+<div class="grid cards">
+ <a href="../reference/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">settings</span>
+ <span class="nav-card-title">Code structure and reference</span>
+ </div>
+ <p class="nav-card-description">Read the reference for more information on our code.</p>
+ </div>
+ </a>
</div>
-
{% include-markdown "../_footer.md" %}
diff --git a/docs/index.md b/docs/index.md
index b4444d11..131ae0a5 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -25,47 +25,47 @@ SWE-agent enables your language model of choice (e.g. GPT-4o or Claude Sonnet 4)
SWE-agent is built and maintained by researchers from Princeton University and Stanford University.
-<div class="grid cards" markdown>
-
-
-
-- :material-download:{ .lg .middle } __Installation__
-
- ---
-
- Installing SWE-agent.
-
- [:octicons-arrow-right-24: Get started](installation/index.md)
-
-
-- :material-cog:{ .lg .middle } __Hello world__
-
- ---
-
- Solve a GitHub issue with SWE-agent.
-
- [:octicons-arrow-right-24: Hello world](usage/hello_world.md)
-
-
-- :material-lightbulb:{ .lg .middle } __User guides__
-
- ---
-
- Dive deeper into SWE-agent's features and goals.
-
- [:octicons-arrow-right-24: User guides](usage/index.md)
-
-
-- :material-book:{ .lg .middle } __Background & goals__
-
- ---
-
- Learn more about the project goals and academic research.
-
- [:octicons-arrow-right-24: Learn more](background/index.md)
-
+<div class="grid cards">
+ <a href="installation/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">download</span>
+ <span class="nav-card-title">Installation</span>
+ </div>
+ <p class="nav-card-description">Installing SWE-agent.</p>
+ </div>
+ </a>
+
+ <a href="usage/hello_world/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">settings</span>
+ <span class="nav-card-title">Hello world</span>
+ </div>
+ <p class="nav-card-description">Solve a GitHub issue with SWE-agent.</p>
+ </div>
+ </a>
+
+ <a href="usage/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">lightbulb</span>
+ <span class="nav-card-title">User guides</span>
+ </div>
+ <p class="nav-card-description">Dive deeper into SWE-agent's features and goals.</p>
+ </div>
+ </a>
+
+ <a href="background/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">book</span>
+ <span class="nav-card-title">Background & goals</span>
+ </div>
+ <p class="nav-card-description">Learn more about the project goals and academic research.</p>
+ </div>
+ </a>
</div>
-
## 📣 News
* July 24: [Mini-SWE-Agent](https://github.com/SWE-agent/mini-SWE-agent) achieves 65% on SWE-bench verified in 100 lines of python!
diff --git a/docs/installation/index.md b/docs/installation/index.md
index b68d4b35..ddd25767 100644
--- a/docs/installation/index.md
+++ b/docs/installation/index.md
@@ -1,41 +1,33 @@
# Setting up SWE-agent
-<div class="grid cards" markdown>
-
-
-- :material-cog:{ .lg .middle } __Install from source__
-
- ---
-
- Install SWE-agent locally from source using `pip`.
- This is the default option.
-
- [:octicons-arrow-right-24: Get started](source.md)
-
-
-- :material-github:{ .lg .middle } __All in browser__
-
- ---
-
- Run SWE-agent using GitHub codespaces in an in-browser VSCode environment.
- Best for a quick first peek.
-
- [:octicons-arrow-right-24: Get started](codespaces.md)
-
-
-- :material-docker:{ .lg .middle } __Coming soon: Run in docker__
-
- ---
-
- Pull a docker container and directly run SWE-agent. This is our fallback solution if the local installation does not work for you.
-
- :octicons-arrow-right-24: Coming soon
-
-- :material-newspaper:{ .lg .middle } __Changelog__
-
- ---
-
- See what's new in SWE-agent!
-
- [:octicons-arrow-right-24: Read the changelog](changelog.md)
+<div class="grid cards">
+ <a href="source/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">settings</span>
+ <span class="nav-card-title">Install from source</span>
+ </div>
+ <p class="nav-card-description">Install SWE-agent locally from source using pip. This is the default option.</p>
+ </div>
+ </a>
+
+ <a href="codespaces/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">code</span>
+ <span class="nav-card-title">All in browser</span>
+ </div>
+ <p class="nav-card-description">Run in a browser-based VSCode environment. Best for a quick first peek.</p>
+ </div>
+ </a>
+
+ <a href="changelog/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">newspaper</span>
+ <span class="nav-card-title">Changelog</span>
+ </div>
+ <p class="nav-card-description">See what's new in SWE-agent!</p>
+ </div>
+ </a>
</div>
diff --git a/docs/usage/index.md b/docs/usage/index.md
index 5931b024..a1b7a9d4 100644
--- a/docs/usage/index.md
+++ b/docs/usage/index.md
@@ -3,38 +3,44 @@
This part of the documentation covers more details about configuring and developing SWE-agent.
Just want to run it? See [getting started](../index.md) instead!
-<div class="grid cards" markdown>
-
-- :material-book:{ .lg .middle } __Background & goals__
-
- ---
-
- Learn more about the project goals and academic research.
-
- [:octicons-arrow-right-24: Learn more](../background/index.md)
-
-- :material-book:{ .lg .middle } __Command line interface__
-
- ---
-
- Learn about all the different subcommands of `sweagent`.
-
- [:octicons-arrow-right-24: Learn more](../usage/cli.md)
-
-- :material-cog:{ .lg .middle } __Configuration__
-
- ---
-
- How to configure SWE-agent.
-
- [:octicons-arrow-right-24: Configuration](../config/config.md)
-
-- :material-image:{ .lg .middle } __Multimodal Support__
-
- ---
-
- Use SWE-agent with vision-capable AI models for image processing.
-
- [:octicons-arrow-right-24: Multimodal Guide](multimodal.md)
-
-</div>
+<div class="grid cards">
+ <a href="../background/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">book</span>
+ <span class="nav-card-title">Background & goals</span>
+ </div>
+ <p class="nav-card-description">Learn more about the project goals and academic research.</p>
+ </div>
+ </a>
+
+ <a href="../usage/cli/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">book</span>
+ <span class="nav-card-title">Command line interface</span>
+ </div>
+ <p class="nav-card-description">Learn about all the different subcommands of sweagent.</p>
+ </div>
+ </a>
+
+ <a href="../config/config/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">settings</span>
+ <span class="nav-card-title">Configuration</span>
+ </div>
+ <p class="nav-card-description">How to configure SWE-agent.</p>
+ </div>
+ </a>
+
+ <a href="multimodal/" class="nav-card-link">
+ <div class="nav-card">
+ <div class="nav-card-header">
+ <span class="material-icons nav-card-icon">image</span>
+ <span class="nav-card-title">Multimodal Support</span>
+ </div>
+ <p class="nav-card-description">Use SWE-agent with vision-capable AI models for image processing.</p>
+ </div>
+ </a>
+</div>
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index fc9b996c..89083161 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -155,6 +155,8 @@ edit_uri: edit/main/docs/
extra_javascript:
- assets/js/sh-annotation.js
extra_css:
+ - https://fonts.googleapis.com/icon?family=Material+Icons
+ - assets/navigation_cards.css
- assets/custom.css
- assets/mkdocstrings.css
- assets/image_theme.css
diff --git a/mlc_config.json b/mlc_config.json
index e885a120..b96ca757 100644
--- a/mlc_config.json
+++ b/mlc_config.json
@@ -29,7 +29,11 @@
},
{
"pattern": ".*\\.md/#sweagent\\..*"
+ },
+ {
+ "pattern": "^(?!https).*(?<!\\.md)$"
}
+
],
"replacements": [
{