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.

chore: organized content for internal review #39

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/application_setup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Setting up a deriv application
sidebar_label: Setting up a deriv application
sidebar_position: 2
title: Setting up a Deriv Application
sidebar_label: Setting up a Deriv Application
sidebar_position: 6
tags:
- intro
- application_setup
Expand Down
8 changes: 8 additions & 0 deletions docs/client-libraries/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Client Libraries",
"position": 3,
"link": {
"type": "generated-index",
"description": "Learn how to use Deriv websocket API features with our Client libraries"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 2,
"link": {
"type": "generated-index",
"description": "5 minutes to learn the most important Docusaurus concepts."
"description": "Flutter Client docs"
}
}
11 changes: 11 additions & 0 deletions docs/client-libraries/flutter/project-setup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Project Setup
sidebar_label: Setup
sidebar_position: 0
---

Please check the library documentations [here](https://github.com/deriv-com/flutter-deriv-api)

:::caution
We're gonna update these pages in the future when we have content for them
:::
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 1,
"link": {
"type": "generated-index",
"description": "5 minutes to learn the most important Docusaurus concepts."
"description": "Python docs"
}
}
11 changes: 11 additions & 0 deletions docs/client-libraries/python/project-setup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Project Setup
sidebar_label: Setup
sidebar_position: 0
---

Please check the library documentations [here](https://binary-com.github.io/python-deriv-api/)

:::caution
We're gonna update these pages in the future when we have content for them
:::
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 0,
"link": {
"type": "generated-index",
"description": "5 minutes to learn the most important Docusaurus concepts."
"description": "Typescript / Javascript docs"
}
}
11 changes: 11 additions & 0 deletions docs/client-libraries/typescript/project-setup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Project Setup
sidebar_label: Setup
sidebar_position: 0
---

Please check the library documentations [here](https://binary-com.github.io/deriv-api/)

:::caution
We're gonna update these pages in the future when we have content for them
:::
2 changes: 1 addition & 1 deletion docs/core-concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Core Concepts",
"position": 3,
"position": 1,
"link": {
"type": "generated-index",
"description": "Learn core concepts of Deriv API websocket server and it's features"
Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/api-calls-anatomy/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: API Calls Anatomy
hide_title: false
hide_title: true
draft: false
sidebar_label: API Calls anatomy
sidebar_position: 1
Expand Down
15 changes: 0 additions & 15 deletions docs/core-concepts/deriv-websocket-calls/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/core-concepts/websocket/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Websocket
hide_title: false
hide_title: true
draft: false
sidebar_label: Websocket
sidebar_position: 0
Expand Down
8 changes: 0 additions & 8 deletions docs/deriv-api/_category_.json

This file was deleted.

6 changes: 0 additions & 6 deletions docs/deriv-api/flutter/project-setup/index.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/deriv-api/python/project-setup/index.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/deriv-api/typescript/project-setup/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/faq/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Frequently Asked Questions",
"position": 7,
"position": 5,
"link": {
"type": "generated-index"
}
Expand Down
7 changes: 0 additions & 7 deletions docs/frameworks/intro.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/frameworks/react/project-setup/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/guides/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Guides",
"position": 7,
"position": 4,
"link": {
"type": "generated-index"
}
Expand Down
19 changes: 7 additions & 12 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,30 @@
---
sidebar_position: 1
sidebar_position: 0
---

# Introduction

Our Documentation is divied in several sections:
Our Documentation is divided in several sections:

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

### Quick Start

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.
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.

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.

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.
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.

### Using our Websocket Server with Deriv API client libraries

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)

### Using our Websocket Server with pure languages
### Using our websocket server with just languages features

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.

:::caution
We suggest using our [Client Libraries](category/deriv-api), since they give you better developer experience.
We suggest using our [Client Libraries](category/client-libraries), since they give you better developer experience.
:::
4 changes: 2 additions & 2 deletions docs/languages/_category_.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Languages",
"position": 4,
"position": 2,
"link": {
"type": "generated-index",
"description": "Learn how to use Deriv websocker API features with your Language of your choice"
"description": "Learn how to use Deriv websocket API features with your Language of your choice"
}
}