Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit 2e92de3

Browse files
authored
Merge pull request #181 from hubert-deriv/branding_removal
2 parents 9663705 + c4b11b5 commit 2e92de3

File tree

34 files changed

+641
-98
lines changed

34 files changed

+641
-98
lines changed

.eslintignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ docusaurus.config.js
33
jest.config.js
44
commitlint.config.js
55
babel.config.js
6-
examples
6+
examples
7+
src/theme

docs/code-examples/javascript/keep-alive/index.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,12 @@ keywords:
1616
description: Keep Alive code example
1717
---
1818

19+
import RenderOfficialContents from '@site/src/components/RenderOfficialContents';
1920
import SandboxIframe from '@site/src/components/SandboxIframe';
2021
import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes';
2122

22-
In this example you'll see how to keep a connection alive when getting contract proposals via the Deriv API. This example keeps the connection alive by sending a ping every 30 seconds.
23+
<RenderOfficialContents>
24+
<p>In this example you'll see how to keep a connection alive when getting contract proposals via the Deriv API. This example keeps the connection alive by sending a ping every 30 seconds.</p>
25+
</RenderOfficialContents>
2326

2427
<SandboxIframe sandbox={sandboxes.keep_alive} />

docs/code-examples/javascript/ticks-history/index.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,16 @@ keywords:
1616
description: Ticks History code example
1717
---
1818

19+
import RenderOfficialContents from '@site/src/components/RenderOfficialContents';
1920
import SandboxIframe from '@site/src/components/SandboxIframe';
2021
import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes';
2122

2223
With ticks history you are able to get a collection of past tick times and prices.
2324

2425
<SandboxIframe sandbox={sandboxes.ticks_history} />
2526

26-
We subscribe to the ticks functionality from the Deriv API websocket to keep track of current and past ticks.
27+
<RenderOfficialContents>
28+
<p>We subscribe to the ticks functionality from the Deriv API websocket to keep track of current and past ticks.</p>
29+
</RenderOfficialContents>
2730

2831
As an example you could create an interactive tick graph.

docs/code-examples/javascript/ticks/index.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,20 @@ keywords:
1414
description: Ticks code example
1515
---
1616

17+
import RenderOfficialContents from '@site/src/components/RenderOfficialContents';
1718
import SandboxIframe from '@site/src/components/SandboxIframe';
1819
import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes';
1920

20-
The easiest way to understand how Deriv API works is to try our Tick call:
21+
<RenderOfficialContents>
22+
<p>The easiest way to understand how Deriv API works is to try our Tick call:</p>
23+
</RenderOfficialContents>
2124

2225
<SandboxIframe sandbox={sandboxes.ticks} />
2326

24-
We'll start with the ticks example because it's a pretty simple block of code to implement. You don't have to log into the Deriv account and get your app authenticated to try it.
27+
<RenderOfficialContents>
28+
<p>We'll start with the ticks example because it's a pretty simple block of code to implement. You don't have to log into the Deriv account and get your app authenticated to try it.</p>
29+
</RenderOfficialContents>
2530

26-
A tick is a measure of minimum upward or downward movement in the price of a trading commodity. We subscribe to the ticks functionality from the Deriv API websocket, which will return new tick data every second. As an example you could create an interactive tick graph with this data.
31+
<RenderOfficialContents>
32+
<p>A tick is a measure of minimum upward or downward movement in the price of a trading commodity. We subscribe to the ticks functionality from the Deriv API websocket, which will return new tick data every second. As an example you could create an interactive tick graph with this data.</p>
33+
</RenderOfficialContents>

docs/core-concepts/_category_.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"className": "hide-sidebar-item",
23
"label": "Core concepts",
34
"position": 2,
45
"link": {

docs/guides/_category_.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"className": "hide-sidebar-item",
23
"label": "Guides",
34
"position": 6,
45
"link": {

docs/guides/monetizing-the-deriv-api/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ hide_title: true
44
draft: false
55
sidebar_label: Monetizing the Deriv API
66
sidebar_position: 1
7+
sidebar_class_name: hide-sidebar-item
78
tags:
89
- concept
910
- earn

docs/intro.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/intro.mdx

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: Introduction
3+
hide_title: false
4+
draft: false
5+
sidebar_label: Introduction
6+
sidebar_position: 0
7+
sidebar_class_name: hide-sidebar-item
8+
tags:
9+
- introduction
10+
- getting started
11+
- quick startup
12+
keywords:
13+
- deriv
14+
- api
15+
- getting started
16+
- quick startup
17+
description: Getting started with Deriv API
18+
---
19+
20+
import RenderOfficialContents from '@site/src/components/RenderOfficialContents';
21+
22+
Our Documentation is divided in several sections:
23+
24+
<RenderOfficialContents>
25+
<ul>
26+
<li><a href='category/core-concepts'>Core concepts</a></li>
27+
<li><a href='category/code-examples'>Code examples</a></li>
28+
<li><a href='category/languages'>Languages</a></li>
29+
<li><a href='category/guides'>Guides</a></li>
30+
<li><a href='setting-up-a-deriv-application'>Setting up a deriv app</a></li>
31+
</ul>
32+
<ul>
33+
<li><a href='category/code-examples'>Code examples</a></li>
34+
</ul>
35+
</RenderOfficialContents>
36+
37+
<h3>Quick Start</h3>
38+
39+
<RenderOfficialContents>
40+
<h4>Core Concepts</h4>
41+
</RenderOfficialContents>
42+
43+
<RenderOfficialContents>
44+
<p>Have a look at the <a href='/docs/category/core-concepts'>Core concepts</a> pages and take your time to read through it. These concepts will help you get familiar with our WebSocket server api and how to use it more efficiently. They are not related to any of our frameworks or libraries.</p>
45+
</RenderOfficialContents>
46+
47+
<RenderOfficialContents>
48+
<p>When you read through the <a href='/docs/category/core-concepts'>Core concepts</a> page, you can start choosing your implementation approach based on the language, framework or library you want to use in your application.</p>
49+
</RenderOfficialContents>
50+
51+
<h4>Code Examples</h4>
52+
53+
<p>If you want to know how you can implement our API within your code, then we suggest to have a look at our <a href='/docs/category/code-examples'>Code examples</a>. These code examples come in `CodeSandboxes`. This allows you to easily fork the code examples and experiment with them for personal use. For now we only have JavaScript code examples, but, we plan to add more examples that are created with different languages, frameworks and libraries in the near future.</p>
54+
55+
<RenderOfficialContents>
56+
<h4>Languages</h4>
57+
</RenderOfficialContents>
58+
59+
<RenderOfficialContents>
60+
<p>When using our code examples, we also suggest to have a look at our <a href='/docs/category/languages'>Languages</a> section. Here, we describe in detail how you can setup your personal project properly to make use of our API. This will surely come helpful when you try to integrate some of our code examples in your own project.</p>
61+
</RenderOfficialContents>
62+
63+
<RenderOfficialContents>
64+
<h4>Guides</h4>
65+
</RenderOfficialContents>
66+
67+
<RenderOfficialContents>
68+
<p>If you want to know for example how you can `monetize your application` or how to create a `secure way for users to log in` to your application, then we provide a handful of <a href='/docs/category/guides'>Guides</a> that can assist you with that.</p>
69+
</RenderOfficialContents>
70+
71+
<RenderOfficialContents>
72+
<h4>Setting up a Deriv application</h4>
73+
</RenderOfficialContents>
74+
75+
<RenderOfficialContents>
76+
<p>If you want to know more about the essentials that are needed to setup your own application, then have a look at the <a href='/docs/setting-up-a-deriv-application'>Setting up a Deriv application</a> section.</p>
77+
</RenderOfficialContents>

docs/languages/_category_.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"className": "hide-sidebar-item",
23
"label": "Languages",
34
"position": 4,
45
"link": {

0 commit comments

Comments
 (0)