Skip to content

Commit a1f2424

Browse files
committed
Rough outline of website
0 parents  commit a1f2424

13 files changed

+210
-0
lines changed

.github/workflows/build-docs.yaml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: build-docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- "build-docs-*"
8+
pull_request:
9+
branches:
10+
- main
11+
permissions:
12+
contents: write
13+
jobs:
14+
deploy:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
- name: Configure Git Credentials
21+
run: |
22+
git config user.name github-actions[bot]
23+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
24+
- uses: actions/setup-python@v5
25+
with:
26+
python-version: 3.x
27+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
28+
- uses: actions/cache@v4
29+
with:
30+
key: mkdocs-material-${{ env.cache_id }}
31+
path: .cache
32+
restore-keys: |
33+
mkdocs-material-
34+
- name: Install uv
35+
run: |
36+
curl -LsSf https://astral.sh/uv/install.sh | sh
37+
- run: uv pip install --python ${Python_ROOT_DIR} '../../requirements.txt'
38+
- name: Build Documentation
39+
if: github.ref != 'refs/heads/main'
40+
run: mkdocs build
41+
- name: Build + Deploy Documentation
42+
if: github.ref == 'refs/heads/main'
43+
run: mkdocs gh-deploy --force

.github/workflows/check-links.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Check Markdown links
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
pull_request:
7+
schedule:
8+
- cron: "0 0 1 * *"
9+
10+
jobs:
11+
markdown-link-check:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@master
15+
- uses: gaurav-nelson/github-action-markdown-link-check@v1

docs/_footer.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<div class="grid cards" markdown>
2+
3+
- :material-bug:{ .lg .middle } __Something broken?__
4+
[:octicons-arrow-right-24: Report bug](https://github.com/princeton-nlp/SWE-agent/issues/new?template=bug_report.yml)
5+
6+
- :material-help:{ .lg .middle } __Something unclear?__
7+
[:octicons-arrow-right-24: Ask question](https://github.com/princeton-nlp/SWE-agent/issues/new?template=question.yml)
8+
9+
</div>

docs/docs/faq.md

Whitespace-only changes.

docs/docs/index.md

Whitespace-only changes.

docs/docs/quickstart.md

Whitespace-only changes.

docs/docs/usage.md

Whitespace-only changes.

docs/index.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Scicode-bench: How good are LMs at science?
2+
3+
Scicode-bench uses more than XX handcollected problem sets from various disciplines to evaluate the ability of LMs to solve any scientific challenge.
4+
5+
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula.
6+
7+
<div class="grid cards" markdown>
8+
9+
- :material-book:{ .lg .middle } __Leaderboard__
10+
11+
---
12+
13+
How good are LMs at science, really?
14+
15+
[:octicons-arrow-right-24: Browse the results](leaderboard.md)
16+
17+
- :material-book:{ .lg .middle } __Preprint__
18+
19+
---
20+
21+
Learn all the details
22+
23+
[:octicons-arrow-right-24: Read the preprint](https://arxiv.com)
24+
</div>
25+
26+
commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus.
27+
28+
Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc.
29+
30+
<div class="grid cards" markdown>
31+
32+
33+
- :material-play:{ .lg .middle } __Installation & usage__
34+
35+
---
36+
37+
Learn how to evaluate your model
38+
39+
[:octicons-arrow-right-24: Read the docs](docs/index.md)
40+
41+
</div>

docs/leaderboard.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Leaderboard
2+
3+
<center>
4+
5+
| Date | Authors | Model | Score | Notes |
6+
| -------- | ------- | --- | --- | --- |
7+
| January | 0.8 |
8+
| February | 0.7 |
9+
| March | 0.6 |
10+
11+
</center>
12+
13+
!!! tip "How to submit"
14+
Want to submit your own model? Head over to the [documentation](docs/index.md).

docs/overrides/main.html

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{% extends "base.html" %}
2+
3+
{% block announce %}
4+
<!-- This link won't work in local preview -->
5+
Some news here: We've just open-sourced our repository.
6+
{% endblock %}

mkdocs.yml

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
site_name: SciCode Benchmark
2+
theme:
3+
name: material
4+
custom_dir: docs/overrides
5+
icon:
6+
repo: fontawesome/brands/github
7+
# logo: assets/swe-agent.svg
8+
palette:
9+
- media: "(prefers-color-scheme)"
10+
toggle:
11+
icon: material/brightness-auto
12+
name: Switch to light mode
13+
- scheme: default
14+
primary: black
15+
accent: deep orange
16+
media: "(prefers-color-scheme: light)"
17+
toggle:
18+
icon: material/weather-night
19+
name: Switch to dark mode
20+
- scheme: slate
21+
primary: black
22+
accent: deep orange
23+
media: "(prefers-color-scheme: dark)"
24+
toggle:
25+
icon: material/weather-sunny
26+
name: Switch to light mode
27+
features:
28+
- navigation.tabs
29+
- navigation.tabs.sticky
30+
- navigation.indexes
31+
- content.action.edit
32+
- navigation.footer
33+
- content.code.copy
34+
- content.footnote.tooltips
35+
- header.autohide
36+
- announce.dismiss
37+
markdown_extensions:
38+
- admonition
39+
- pymdownx.details
40+
- pymdownx.superfences
41+
- pymdownx.magiclink
42+
- footnotes
43+
- attr_list
44+
- md_in_html
45+
- pymdownx.snippets:
46+
check_paths: true
47+
- pymdownx.emoji:
48+
emoji_index: !!python/name:material.extensions.emoji.twemoji
49+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
50+
nav:
51+
- Overview: index.md
52+
- Leaderboard: leaderboard.md
53+
- Preprint: "https://arxiv.org"
54+
- Documentation:
55+
- "docs/index.md"
56+
- Quickstart: docs/quickstart.md
57+
- Usage: docs/usage.md
58+
- FAQ: docs/faq.md
59+
plugins:
60+
- glightbox
61+
- search
62+
- include-markdown
63+
repo_url: https://github.com/pscicode-bench/website-draft
64+
repo_name: sicode-bench/website-draft
65+
edit_uri: edit/main/docs/

mlc_config.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "https://github.com/issues?.*"
5+
},
6+
{
7+
"pattern": "https://github.com/?.*/pull/?.*"
8+
},
9+
{
10+
"pattern": ".*localhost.*"
11+
}
12+
]
13+
}

requirements.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
mkdocs
2+
mkdocs-material
3+
mkdocs-glightbox
4+
mkdocs-include-markdown-plugin

0 commit comments

Comments
 (0)