Skip to content

Commit 9e68f35

Browse files
committed
website: fixing some nits:
https://screenshot.googleplex.com/70zBTvkh5GK.png https://screenshot.googleplex.com/pnpqOkvxZ8g.png https://screenshot.googleplex.com/RYDpRHZDsj6.png -Bolded heading text -More padding around sections -Fixing the sidebar when in "narrow-screen" mode -Fixing logo jumping few pixels between landing and subsites -Wording fix Alex proposed Change-Id: I30e8366ba71944bb7108c0db4f88ae0857994bc8
1 parent 770e2d1 commit 9e68f35

File tree

12 files changed

+69
-46
lines changed

12 files changed

+69
-46
lines changed

browser/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ domready(function() {
1717
var sidebarEl = dom.find('.sidebar');
1818
if (sidebarEl) {
1919
ReactDOM.render(Sidebar({
20+
subsite: sidebarEl.dataset.subsite,
2021
items: parseSidebarProps(dom.find('.sidebar-data'))
2122
}), sidebarEl);
2223

browser/sidebar.js

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,38 @@ function renderItems(items) {
8080
});
8181
}
8282

83+
function renderLogo(subsite) {
84+
var title;
85+
var href;
86+
if (subsite === 'syncbase') {
87+
title = 'Syncbase';
88+
href = '/syncbase';
89+
} else {
90+
title = 'Core';
91+
href = '/core.html';
92+
}
93+
94+
return h('div.logo-row', [
95+
h('div.icon.v-icon', {},
96+
h('a', {href: '/'},
97+
h('img', {
98+
src: '/images/v-icon-cyan-700.svg'
99+
})
100+
)
101+
),
102+
h('div.logo', {},
103+
h('a', {href: href}, title)
104+
)
105+
]);
106+
}
107+
83108
// Expects props {items []Item}, where Item is either {text, items []Item} or
84109
// {text, href}.
85110
module.exports = React.createClass({
86111
displayName: 'Sidebar',
87112
render: function() {
88113
return h('div', [
89-
h('div.logo-row', [
90-
h('div.icon.v-icon', {}, h('img', {
91-
src: '/images/v-icon-cyan-700.svg'
92-
})),
93-
h('div.logo', 'Vanadium')
94-
]),
114+
renderLogo(this.props.subsite),
95115
h('div.items', renderItems(this.props.items))
96116
]);
97117
}

content/syncbase/example-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: syncbase
44
toc: true
55
= yaml =
66

7-
# Todos *(canonical example)*
7+
# Todos *(Canonical Example)*
88

99
* Repo: https://github.com/vanadium/todos
1010

content/syncbase/first-app.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Make note of the Syncbase **Address** and the **Blessing** for your cloud
5656
instance, they are required by the Syncbase API during initialization.
5757

5858
{{# helpers.info }}
59-
## Please note
59+
## Note
6060
Requiring a cloud Syncbase is temporary. We are planning to allow the API to be
6161
used without a cloud Syncbase very soon.
6262
{{/ helpers.info }}
@@ -298,12 +298,12 @@ the `Select a Deployment Target`. If you prefer to use the command line
298298
tool that makes it easy to run Android apps on multiple devices.
299299

300300
{{# helpers.info }}
301-
## Please note
301+
## Note
302302
Internet connectivity is required the first time the app is run to authenticate
303303
the user and generate an offline auth certificate.
304-
Subsequence runs do not require Internet connectivity for 24 hours. (Auth protocol
305-
starts trying to refresh the certificate after 12 hours and it would expire in
306-
24 hours if all tries are unsuccessful).
304+
Subsequent runs generally do not require Internet connectivity. The auth
305+
protocol refreshes its certificate automatically after 12 hours, but the
306+
certificate will expire if a device is offline for more than 24 hours.
307307
{{/ helpers.info }}
308308

309309
After running the application on 2 or more devices with Internet connectivity,
@@ -319,7 +319,7 @@ cd $PROJECT_DIR && ./gradlew assembleRelease
319319
```
320320
{{/ helpers.hidden }}
321321

322-
# Want to dive deeper?
322+
# Want to Dive Deeper?
323323
Checkout the [Tutorial] to build a full-fledged Todo app and learn more Syncbase
324324
features such as sharing, batches and discovery.
325325

content/syncbase/guides/synchronization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ By default, creating a collection creates an associated syncgroup, initially
3838
synced amongst the creator’s devices but other users can also be added to this
3939
syncgroup to allow sharing.
4040

41-
## Sharing collections
41+
## Sharing Collections
4242

4343
Sharing collections involves **inviting** other users to **join** a collection's
4444
syncgroup. Upon inviting a user, the invitee **receives an invite event**. When
@@ -84,7 +84,7 @@ syncing into the invitee's database. As the collection syncs, data will be
8484
surfaced through the *Watch API*. See [Data Flow] guide for details on how
8585
to model your app's data flow.
8686

87-
## Unsharing collections
87+
## Unsharing Collections
8888

8989
Ejecting a user from a collection's syncgroup will unshare the collection. If
9090
the target user has not accepted the invitation yet, the invite will simply

content/syncbase/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Syncbase runs on both Android and iOS (coming soon).
1212

1313
<figcaption>Syncbase Overview</figcaption>
1414

15-
# Why use Syncbase?
15+
# Why Use Syncbase?
1616

1717
<div class="intro-detail intro-detail-offline">
1818
<p>
@@ -60,7 +60,7 @@ configurable conflict resolution we want. In summary, we're trying to solve a
6060
bunch of problems simultaneously whereas those other systems each solve a subset
6161
of those problems.
6262

63-
# Ready to get started?
63+
# Ready to Get Started?
6464

6565
The initial version of Syncbase is ready for testing and evaluation by early
6666
adopters - it is suitable for prototyping, but not for production applications.

content/syncbase/my-cloud-syncbase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Each instance is running in a dedicated container, isolated from all the other
1414
instances. Access is restricted to the creator of the instance.
1515

1616
{{# helpers.warning }}
17-
## Please note
17+
## Note
1818

1919
The instances are meant to be used for development. There are no guarantees
2020
about availability or performance. Data stored in the instances can be lost at

content/syncbase/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Make note of the Syncbase **Address** and the **Blessing** for your cloud
4949
instance, they are required by the Syncbase API during initialization.
5050

5151
{{# helpers.info }}
52-
## Please note
52+
## Note
5353
Requiring a cloud Syncbase is temporary. We are planning to allow the API to be
5454
used without a cloud Syncbase soon.
5555
{{/ helpers.info }}
@@ -110,7 +110,7 @@ cd $PROJECT_DIR && ./gradlew assembleRelease
110110
```
111111
{{/ helpers.hidden }}
112112

113-
# Got 10 more minutes?
113+
# Got 10 More Minutes?
114114
Let's create a simple *Dice Roller* app and see it sync peer-to-peer in action!
115115

116116
<a href="/syncbase/first-app.html" class="button-passive">

stylesheets/home.less

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@
3636
section {
3737
max-width: 100%;
3838
width: 100%;
39-
padding: @gutter;
39+
padding: (2 * @gutter) @gutter;
4040
}
4141

4242
.menu {
4343
display: none !important;
4444
}
4545

4646
.v-icon {
47-
display: block !important;
47+
display: flex !important;
4848
}
4949

5050
.section-container {
@@ -53,23 +53,25 @@
5353
}
5454

5555
h1, h2, h3 {
56-
font-weight: 100;
5756
margin: @gutter-half 0px;
5857
}
5958

6059
h1 {
6160
color: @color-white;
6261
font-size: @intro-heading-font-size;
62+
font-weight: 400;
6363
}
6464

6565
h2 {
6666
color: @color-primary-700;
6767
font-size: @intro-subheading-font-size;
68+
font-weight: 100;
6869
}
6970

7071
h3 {
7172
color: @color-blue-grey-500;
7273
font-size: @intro-text-font-size;
74+
font-weight: 100;
7375
}
7476

7577
.intro {

stylesheets/sidebar.less

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,31 @@
2929

3030
.items {
3131
padding: @gutter-half 0;
32-
}
33-
34-
a {
35-
display: block;
36-
padding: @gutter-quarter @gutter-half;
37-
color: @color-text-primary;
38-
font-size: 14px;
39-
font-weight: 400;
4032

41-
&.active {
42-
background-color: @color-blue-grey-100;
43-
font-weight: 500;
33+
a {
34+
display: block;
35+
padding: @gutter-quarter @gutter-half;
36+
color: @color-text-primary;
37+
font-size: 14px;
38+
font-weight: 400;
39+
40+
&.active {
41+
background-color: @color-blue-grey-100;
42+
font-weight: 500;
43+
}
4444
}
45-
}
4645

47-
nav {
48-
overflow: hidden;
46+
nav {
47+
overflow: hidden;
4948

50-
a {
51-
padding: 6px;
52-
padding-left: @gutter;
53-
font-size: 13px;
54-
}
49+
a {
50+
padding: 6px;
51+
padding-left: @gutter;
52+
font-size: 13px;
53+
}
5554

56-
nav a {
57-
padding-left: calc(@gutter + @gutter-half);
55+
nav a {
56+
padding-left: calc(@gutter + @gutter-half);
57+
}
5858
}
5959
}

templates/partials/core_sidebar.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Note to contributors: The sidebar items and ordering were tested extensively for
33
usability. Changes here should not be taken lightly.
44
}}
5-
<div class="sidebar"></div>
5+
<div data-subsite="core" class="sidebar"></div>
66
{{! TODO(sadovsky): Transmit data as JSON, not HTML. }}
77
<div class="sidebar-data">
88
<a href="/core.html">Overview</a>

templates/partials/syncbase_sidebar.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Note to contributors: The sidebar items and ordering were tested extensively for
33
usability. Changes here should not be taken lightly.
44
}}
5-
<div class="sidebar"></div>
5+
<div data-subsite="syncbase" class="sidebar"></div>
66
{{! TODO(sadovsky): Transmit data as JSON, not HTML. }}
77
<div class="sidebar-data">
88
<a href="/syncbase/">Overview</a>

0 commit comments

Comments
 (0)