Skip to content

Commit e293fc9

Browse files
authored
Merge pull request #640 from PAIR-code/docs
Update Jekyll documentation site to match PR #634 changes
2 parents 23dd469 + dfe9bad commit e293fc9

File tree

6 files changed

+35
-15
lines changed

6 files changed

+35
-15
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
🕊️ **Deliberate Lab** is a platform for running online research experiments
44
on human + LLM group dynamics.
55

6+
<img
7+
src="./docs/assets/images/deliberate-lab-example-tv-debate.png"
8+
alt="Screenshot of Deliberate Lab experiment dashboard"
9+
/>
10+
611
- 🔎 [Documentation for researchers + developers](https://pair-code.github.io/deliberate-lab/)
712
- 👉 [Quick start for developers](https://pair-code.github.io/deliberate-lab/developers/run-locally)
813

docs/_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# You can create any custom variable you would like, and they will be accessible
1919
# in the templates via {{ site.myvariable }}.
2020

21-
title: Deliberate Lab Docs
21+
title: Deliberate Lab
2222
author: Google PAIR
2323
email: llm-mediation-core@google.com
2424
description: >- # this means to ignore newlines
@@ -33,7 +33,7 @@ keywords: >-
3333
research,
3434
baseurl: "/deliberate-lab" # the subpath of your site, e.g. /blog
3535
url: "https://pair-code.github.io" # the base hostname & protocol for your site
36-
github_username: pair-code
36+
github_username: PAIR-code
3737
collections:
3838
pages:
3939
order: # TODO: update

docs/_layouts/default.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@
1919
{% include sidenav.html %}
2020
<article>
2121
<div class="content-wrapper">
22-
<h1>{{ page.title }}</h1>
22+
<header>
23+
<h1>{{ page.title }}</h1>
24+
{%- if page.subtitle -%}
25+
<div class="subtitle">{{ page.subtitle }}</div>
26+
{%- endif -%}
27+
</header>
2328
{{ content }}
2429
</div>
2530
</article>

docs/assets/css/main.css

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ body {
1010
--md-sys-color-on-surface: var(--md-ref-palette-gray5);
1111
--md-sys-color-gray: var(--md-ref-palette-gray40);
1212
--md-sys-color-blue: var(--md-ref-palette-blue40);
13-
--md-sys-color-blue-light: var(--md-ref-palette-blue50);
13+
--md-sys-color-blue-light: var(--md-ref-palette-blue60);
1414

1515
background: #fefefe;
1616
font-family: 'Roboto', Helvetica, sans-serif;
@@ -94,9 +94,7 @@ article {
9494
align-items: center;
9595
display: flex;
9696
flex-shrink: 0;
97-
font-family: 'Roboto Mono';
9897
font-size: 0.9em;
99-
font-weight: 500;
10098
height: 40px;
10199
border-bottom: 1px solid var(--md-sys-color-outline);
102100
padding: 0 1em;
@@ -112,7 +110,6 @@ article {
112110

113111
.nav-section-title {
114112
color: var(--md-sys-color-outline);
115-
font-family: 'Roboto Mono';
116113
font-size: 0.7em;
117114
font-weight: 400;
118115
text-transform: uppercase;
@@ -134,26 +131,34 @@ a.nav-link:hover {
134131
}
135132

136133
header {
134+
align-items: center;
135+
display: flex;
136+
flex-direction: column;
137137
padding: 0.75em;
138138
}
139139

140-
h1 {
141-
font-family: 'Roboto Mono';
140+
.subtitle {
142141
font-size: 1.2em;
142+
line-height: 1.3em;
143+
text-align: center;
144+
}
145+
146+
h1 {
147+
font-size: 2em;
143148
font-weight: 500;
149+
line-height: 1.5em;
150+
text-align: center;
144151
}
145152

146153
h2 {
147154
color: var(--md-sys-color-blue);
148155
border-bottom: 2px solid var(--md-sys-color-blue-light);
149-
margin-top: 2em;
156+
margin-top: 1em;
150157
padding-bottom: 4px;
151-
font-family: 'Roboto Mono';
152158
}
153159

154160
h3 {
155161
color: var(--md-sys-color-outline);
156-
font-family: 'Roboto Mono';
157162
font-size: 0.9em;
158163
font-weight: 500;
159164
}
714 KB
Loading

docs/index.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
2-
title: Home
2+
title: Deliberate Lab
3+
subtitle: Create and run human-LLM group experiments
34
layout: default
45
---
56

6-
Deliberate Lab is a platform for running online research experiments on human +
7-
LLM group dynamics.
7+
<img
8+
src="./assets/images/deliberate-lab-example-tv-debate.png"
9+
alt="Screenshot of Deliberate Lab experiment dashboard"
10+
/>
11+
12+
## Information
813

914
> [Log into the Google-hosted platform](https://deliberate-lab.appspot.com/){:target="_blank"}
1015
(or [request access here](https://forms.gle/VCmYQxsZWEA3mbZN6){:target="_blank"})

0 commit comments

Comments
 (0)