Skip to content

Commit 1c6214c

Browse files
Merge pull request #79 from chronicleprotocol/devJ
Add getting started page
2 parents aa5a173 + a1f6682 commit 1c6214c

File tree

7 files changed

+2859
-2445
lines changed

7 files changed

+2859
-2445
lines changed

docs/Developers/start.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
import CallToActionButton from '@site/src/components/CallToActionButton';
5+
6+
# Getting Started
7+
## How do I start?
8+
9+
<div>
10+
<CallToActionButton
11+
style={{
12+
display: 'inline-block !important',
13+
}}
14+
icon="material-symbols:counter-1"
15+
color="black"
16+
target="_blank"
17+
link="Guides/whitelistAddress"
18+
text="Explore Chronicle Oracles on Testnet"
19+
/>
20+
21+
{' '}
22+
23+
<div
24+
style={{
25+
display: 'flex',
26+
justifyContent: 'center',
27+
fontSize: '3em',
28+
}}
29+
>
30+
<p>↓</p>
31+
</div>
32+
33+
{' '}
34+
35+
<CallToActionButton
36+
icon="material-symbols:counter-2"
37+
color="black"
38+
target="_blank"
39+
link="https://chroniclelabs.org/dashboard"
40+
text="Integrate Chronicle Oracles on Mainnet"
41+
/>
42+
43+
<div
44+
style={{
45+
display: 'flex',
46+
justifyContent: 'center',
47+
fontSize: '3em',
48+
}}
49+
>
50+
<p>↓</p>
51+
</div>
52+
</div>
53+
54+
<CallToActionButton
55+
icon="material-symbols:counter-3"
56+
color="black"
57+
target="_blank"
58+
link="https://forms.gle/EANjn7THKKieSYaF7"
59+
text="Request a New Oracle/Chain"
60+
/>
61+
Currently, Chronicle Oracles provide real-time data to smart contract applications on nine chains. More ecosystems are coming soon!
62+
63+
To get started, check out the [Getting Read Access to Contracts](docs/Developers/Guides/whitelistAddress.md) guide to learn how to integrate Chronicle Oracles into your dApp.
64+
65+
Once you become familiar with the Testnet, get in touch to request access to the Chronicle Oracles on Mainnet. Chronicle contracts use a whitelist for read protection, so the addresses used for consuming the Oracle data must be whitelisted first. On the Testnet, you can whitelist yourself.
66+
67+
If you want to request an Oracle that is not yet integrated, you could do so using [this form](https://forms.gle/EANjn7THKKieSYaF7) or by writing us a message on [Discord](https://discord.com/invite/CjgvJ9EspJ) via the 🆘|support channel.

docs/Developers/testnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 2
33
---
44

55
# Testnet Addresses

docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import {themes as prismThemes} from 'prism-react-renderer';
88

99
/** @type {import('@docusaurus/types').Config} */
1010
const config = {
11+
plugins: ['docusaurus-plugin-sass'],
1112
title: 'Chronicle Docs',
1213
tagline: 'Cost-efficient. Verifiable Data.',
1314
favicon: 'img/favicon.ico',

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,17 @@
1717
"@cookbookdev/docsbot": "^4.21.5",
1818
"@docusaurus/core": "3.0.1",
1919
"@docusaurus/preset-classic": "3.0.1",
20+
"@iconify/react": "^5.0.2",
2021
"@markprompt/docusaurus-theme-search": "^0.26.1",
2122
"@mdx-js/react": "^3.0.0",
23+
"acorn-import-assertions": "^1.9.0",
2224
"clsx": "^2.0.0",
25+
"docusaurus-plugin-sass": "^0.2.5",
2326
"prism-react-renderer": "^2.3.0",
2427
"pushfeedback-react": "^0.1.40",
2528
"react": "^18.0.0",
26-
"react-dom": "^18.0.0"
29+
"react-dom": "^18.0.0",
30+
"sass": "^1.77.8"
2731
},
2832
"devDependencies": {
2933
"@docusaurus/module-type-aliases": "3.0.1",
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.ctaContainer {
2+
height: 50px;
3+
display: flex;
4+
align-items: center;
5+
justify-content: center;
6+
text-align: center;
7+
}
8+
9+
.ctaButton {
10+
// background-color: var(--color-cta-background);
11+
background-color: #84E39E;
12+
border-radius: 40px;
13+
padding: 10px 20px;
14+
max-width: 500px;
15+
margin-bottom: 30px;
16+
border: #123723 solid 2px;
17+
18+
display: flex;
19+
align-items: center;
20+
justify-content: center;
21+
text-align: center;
22+
23+
transition: all 200ms ease-out 10ms;
24+
25+
color: white;
26+
27+
&:hover {
28+
box-shadow: 0 6px 16px 0 rgba(0, 0, 0, 0.1);
29+
transform: scale(1.05);
30+
border: #0a2313 solid 1px;
31+
text-decoration: none;
32+
}
33+
34+
a:hover {
35+
color: white !important;
36+
}
37+
}
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import React from 'react';
2+
import styles from './CallToActionButton.module.scss';
3+
4+
import { Icon } from '@iconify/react';
5+
6+
export default function CallToActionButton({
7+
bgColor,
8+
color,
9+
link,
10+
text,
11+
icon,
12+
target,
13+
}) {
14+
return (
15+
<div className={styles.ctaContainer}>
16+
<a
17+
style={{ backgroundColor: bgColor, display: 'flex' }}
18+
className={styles.ctaButton}
19+
href={link}
20+
target={target}
21+
>
22+
<Icon
23+
icon={icon}
24+
style={{ width: '1.75em', height: '1.75em', marginRight: '0.5em' }}
25+
/>
26+
<strong style={{ color: color }}>{text}</strong>
27+
</a>
28+
</div>
29+
);
30+
}

0 commit comments

Comments
 (0)