Thanks to visit codestin.com
Credit goes to github.com

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

Commit f19cbe1

Browse files
mohsen-derivmohsen-deriv
authored
Merge pull request #39 from mohsen-deriv/organize-docs-for-internal-review
chore: organized content for internal review
2 parents 01be5b5 + d83a57b commit f19cbe1

File tree

23 files changed

+61
-79
lines changed

23 files changed

+61
-79
lines changed

‎docs/application_setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Setting up a deriv application
3-
sidebar_label: Setting up a deriv application
4-
sidebar_position: 2
2+
title: Setting up a Deriv Application
3+
sidebar_label: Setting up a Deriv Application
4+
sidebar_position: 6
55
tags:
66
- intro
77
- application_setup

‎docs/client-libraries/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Client Libraries",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn how to use Deriv websocket API features with our Client libraries"
7+
}
8+
}

‎docs/deriv-api/flutter/_category_.json renamed to ‎docs/client-libraries/flutter/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "Flutter Client docs"
77
}
88
}

‎docs/client-libraries/flutter/project-setup/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Project Setup
3+
sidebar_label: Setup
4+
sidebar_position: 0
5+
---
6+
7+
Please check the library documentations [here](https://github.com/deriv-com/flutter-deriv-api)
8+
9+
:::caution
10+
We're gonna update these pages in the future when we have content for them
11+
:::

‎docs/deriv-api/intro.md renamed to ‎docs/client-libraries/intro.md

File renamed without changes.

‎docs/deriv-api/python/_category_.json renamed to ‎docs/client-libraries/python/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 1,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "Python docs"
77
}
88
}

‎docs/client-libraries/python/project-setup/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Project Setup
3+
sidebar_label: Setup
4+
sidebar_position: 0
5+
---
6+
7+
Please check the library documentations [here](https://binary-com.github.io/python-deriv-api/)
8+
9+
:::caution
10+
We're gonna update these pages in the future when we have content for them
11+
:::

‎docs/deriv-api/typescript/_category_.json renamed to ‎docs/client-libraries/typescript/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 0,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "Typescript / Javascript docs"
77
}
88
}

‎docs/client-libraries/typescript/project-setup/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Project Setup
3+
sidebar_label: Setup
4+
sidebar_position: 0
5+
---
6+
7+
Please check the library documentations [here](https://binary-com.github.io/deriv-api/)
8+
9+
:::caution
10+
We're gonna update these pages in the future when we have content for them
11+
:::

‎docs/core-concepts/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Core Concepts",
3-
"position": 3,
3+
"position": 1,
44
"link": {
55
"type": "generated-index",
66
"description": "Learn core concepts of Deriv API websocket server and it's features"

‎docs/core-concepts/api-calls-anatomy/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: API Calls Anatomy
3-
hide_title: false
3+
hide_title: true
44
draft: false
55
sidebar_label: API Calls anatomy
66
sidebar_position: 1

‎docs/core-concepts/deriv-websocket-calls/index.md

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

‎docs/core-concepts/websocket/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Websocket
3-
hide_title: false
3+
hide_title: true
44
draft: false
55
sidebar_label: Websocket
66
sidebar_position: 0

‎docs/deriv-api/_category_.json

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

‎docs/deriv-api/flutter/project-setup/index.md

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

‎docs/deriv-api/python/project-setup/index.md

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

‎docs/deriv-api/typescript/project-setup/index.md

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

‎docs/faq/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Frequently Asked Questions",
3-
"position": 7,
3+
"position": 5,
44
"link": {
55
"type": "generated-index"
66
}

‎docs/frameworks/intro.md

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

‎docs/frameworks/react/project-setup/index.md

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

‎docs/guides/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Guides",
3-
"position": 7,
3+
"position": 4,
44
"link": {
55
"type": "generated-index"
66
}

‎docs/intro.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,30 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 0
33
---
44

55
# Introduction
66

7-
Our Documentation is divied in several sections:
7+
Our Documentation is divided in several sections:
88

99
- [Setting up a deriv app](/docs/application_setup.md)
1010
- [Core Concepts](category/core-concepts)
1111
- [Languages](category/languages)
12-
- [Deriv Api client libraries](category/deriv-api)
13-
- [Integration with Front-End Frameworks](category/frameworks)
12+
- [Client libraries](category/client-libraries)
1413
- [Frequently Asked Questions](category/frequently-asked-questions)
1514
- [Guides](category/guides)
1615

1716
### Quick Start
1817

19-
Please skim through our [Core Concept](category/core-concepts) pages, these pages will help get familiar with our `websocket server api` features, the concepts introduced in these pages are not related to any of our frameworks or libraries, so in order to use our `websocket server api` in an efficeint way it's better if you grasp all the information provided there.
18+
Please skim through our [Core Concept](category/core-concepts) pages, these pages will help get familiar with our `websocket server api` features, the concepts introduced in these pages are not related to any of our frameworks or libraries, so in order to use our `websocket server api` in an efficient way it's better if you grasp all the information provided there.
2019

2120
When you're done with [Core Concept](category/core-concepts) you can choose your implementation approach based on the language / framework / library you want to work with in your application.
2221

23-
Using our [Deriv API Client Libraries](category/deriv-api) is optional and you can get the same result with the tutorials provided in [Languages Section](category/languages) as well, but our client libraries provide more `robust`, `type safe` API calls for you.
22+
Using our [Client Libraries](category/client-libraries) is optional and you can get the same result with the tutorials provided in [Languages Section](category/languages) as well, but our client libraries provide more `robust`, `type safe` API calls for you.
2423

25-
### Using our Websocket Server with Deriv API client libraries
26-
27-
Using our [Deriv API Clients](category/deriv-api) is the best approach for creating applications based on our `websocket api server`, in the future we will provide integrations for most of front end libraries and frameworks, you can check the progress in [here](category/frameworks)
28-
29-
### Using our Websocket Server with pure languages
24+
### Using our websocket server with just languages features
3025

3126
If you decided that you want to use our `websocket server` with pure languages feature of your choice please check out [Languages Section](category/languages) continue your journey from there.
3227

3328
:::caution
34-
We suggest using our [Client Libraries](category/deriv-api), since they give you better developer experience.
29+
We suggest using our [Client Libraries](category/client-libraries), since they give you better developer experience.
3530
:::

‎docs/languages/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"label": "Languages",
3-
"position": 4,
3+
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "Learn how to use Deriv websocker API features with your Language of your choice"
6+
"description": "Learn how to use Deriv websocket API features with your Language of your choice"
77
}
88
}

0 commit comments

Comments
 (0)