Skip to content

Commit 16773f9

Browse files
committed
no atomicdex in paths/names
1 parent 5556d0a commit 16773f9

21 files changed

+36
-33
lines changed

STYLE_GUIDE.md

+22-19
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Be mindful of any feedback you receive from users, and let it guide you to impro
2626
- Where a request includes optional parameters which will result in different response structures, the file should contain a code block for each possible request variation, followed by a code block for the response of each example.
2727
- Below the request/response examples, include code blocks for each potential error response, along with details on what causes the error and how it might be resolved.
2828
- In some cases, it may be appropriate to group related methods together in a single `index.mdx` file. For example, the `index.mdx` file within the `task_init_trezor` folder contains documentation for all methods for initialisation and authentication with a Trezor hardware wallet.
29-
- Where common structures exist in the request or response of mulitple methods, these should be documented in the `index.mdx` file in the base folder for a section (e.g. [src/pages/atomicdex/api/v20/index.mdx](src/pages/atomicdex/api/v20/index.mdx)), and linked to from request/response parameter tables where required.
29+
- Where common structures exist in the request or response of mulitple methods, these should be documented in the `index.mdx` file in the base folder for a section (e.g. [src/pages/komodo-defi-framework/api/v20/index.mdx](src/pages/komodo-defi-framework/api/v20/index.mdx)), and linked to from request/response parameter tables where required.
3030
- Where a method or parameter is deprecated, this should be communicated in the method heading or request parameters table.
3131
- Separate sections of content with subheadings to make scanning and finding the information they need easier. Two line breaks should be used before and one line break after each subheading.
3232

@@ -44,7 +44,7 @@ Be mindful of any feedback you receive from users, and let it guide you to impro
4444
- Use simple language: Where possible, avoid jargon or technical terms that may be unfamiliar to the reader. When unavoidable, provide a link to a definition or explanation of the term.
4545
- Proofread and test your content: Make sure to proofread your MDX file for errors and test any code snippets or examples to ensure they work as expected.
4646
- Be generous with hyperlinks: Link to relevant documentation or resources, whether to somewhere else within our internal docs or to a respected external source. This will provide additional context and help users better understand the content.
47-
- Use absolute links for internal docs: The `pages` folder is the root directory for internal docs. Use absolute links to reference other pages within the `pages` folder, for example: `[AtomicDEX API methods](/atomicdex/api/#sub-section-header)`. The url must end with a slash.
47+
- Use absolute links for internal docs: The `pages` folder is the root directory for internal docs. Use absolute links to reference other pages within the `pages` folder, for example: `[Komodo DeFi Framework API methods](/komodo-defi-framework/api/#sub-section-header)`. The url must end with a slash.
4848
- Use bullet points and numbered lists to break up long paragraphs to make the content more readable.
4949

5050
## Syntax
@@ -68,23 +68,23 @@ Be mindful of any feedback you receive from users, and let it guide you to impro
6868

6969
For example:
7070

71-
| Parameter | Type | Description |
72-
| --------- | ------- | --------------------------------------------------------------------------------------- |
73-
| coin | string | The name of the coin the user desires to activate. |
74-
| fee | object | Optional. A standard [FeeInfo](/atomicdex/api/common_structures/#FeeInfo) object. |
75-
| amount | float | Required, unless `max` is `true`. The amount of balance to send. |
76-
| max | boolean | Optional, defaults to `false`. Send whole balance. |
77-
| memo | string | Optional, used for ZHTLC and Tendermint coins only. Attaches a memo to the transaction. |
71+
| Parameter | Type | Description |
72+
| --------- | ------- | --------------------------------------------------------------------------------------------- |
73+
| coin | string | The name of the coin the user desires to activate. |
74+
| fee | object | Optional. A standard [FeeInfo](/komodo-defi-framework/api/common_structures/#FeeInfo) object. |
75+
| amount | float | Required, unless `max` is `true`. The amount of balance to send. |
76+
| max | boolean | Optional, defaults to `false`. Send whole balance. |
77+
| memo | string | Optional, used for ZHTLC and Tendermint coins only. Attaches a memo to the transaction. |
7878

7979
## Variables
8080

81-
- For AtomicDEX-API methods, the userpass variable should always be `testpsw`
81+
- For Komodo DeFi Framework API methods, the userpass variable should always be `testpsw`
8282

8383
## Templates
8484

8585
Use the linked templates below as a starting point for new documentation pages.
8686

87-
- [AtomicDEX API methods](templates/atomicdex_method.mdx)
87+
- [Komodo DeFi Framework API methods](templates/komodefi_method.mdx)
8888

8989
## How to contribute
9090

@@ -166,12 +166,13 @@ MDX supports standard markdown by default [CommonMark](https://commonmark.org/).
166166

167167
The `CodeGroup` acts as a wrapper around code blocks. It allows us to have tabbed content (or not, if it's a single block) with properties such as **title, tags, labels and more**. An example would look something like this:
168168

169-
```mdx
169+
````mdx
170170
<CodeGroup title="Code Sample" tag="post" label="/kmd/jwt/post" >
171171

172172
```ts
173173
// ...
174174
```
175+
````
175176

176177
```python
177178

@@ -204,7 +205,7 @@ And you'll still have it rendered correctly:
204205
205206
![Single code block UI](style-guide-images/single-code-block.png) -->
206207
207-
It is important to **note that**, "**AtomicDEX methods**" should be wrapped with `CodeGroup` tags, using the **method name** as the **label value**, and the **tag value** set to **POST**, an additional **mm2MethodDecorate property** with the value **"true"**. This will generate code blocks for:
208+
It is important to **note that**, "**Komodo DeFi Framework methods**" should be wrapped with `CodeGroup` tags, using the **method name** as the **label value**, and the **tag value** set to **POST**, an additional **mm2MethodDecorate property** with the value **"true"**. This will generate code blocks for:
208209
209210
- **JSON**: The pure request body.
210211
- **Python3**: Using the requests library.
@@ -218,7 +219,7 @@ You only need to include the `json` data, and the additional **mm2MethodDecorate
218219
219220
A working code sample would look like this:
220221
221-
```mdx
222+
````mdx
222223
<CodeGroup title="Generate Invoice" tag="POST" label="generate_invoice" mm2MethodDecorate="true">
223224
224225
```json
@@ -233,6 +234,7 @@ A working code sample would look like this:
233234
"id": 56
234235
}
235236
```
237+
````
236238
237239
</CodeGroup>
238240
```
@@ -287,7 +289,7 @@ This renders a button with a specified text based on its state (expanded or coll
287289
288290
You'll mostly use this for API, Commands, etc. Responses, which should be wrapped with the `CollapsibleSection` tags, for example:
289291
290-
```mdx
292+
````mdx
291293
<CollapsibleSection expandedText='Hide Response' collapsedText='Show Response'>
292294
#### Response (ready, successful)
293295
@@ -300,13 +302,13 @@ You'll mostly use this for API, Commands, etc. Responses, which should be wrappe
300302
```
301303
302304
</CollapsibleSection>
303-
```
305+
````
304306

305307
The `CollapsibleSection` tags should also wrap all error responses (as a group), with the `expandedText` and `collapsedText` values set to '**Show Error Responses**' and '**Hide Error Responses' respectively**.
306308

307309
A working code would look like this:
308310

309-
```mdx
311+
````mdx
310312
<CollapsibleSection expandedText='Hide code' collapsedText='Show code'>
311313

312314
```json
@@ -318,6 +320,7 @@ A working code would look like this:
318320
"date": "2078-05-16"
319321
}
320322
```
323+
````
321324

322325
</CollapsibleSection>
323326
```
@@ -330,13 +333,13 @@ Rendered as:
330333
331334
Images should be added to the related subfolder within the `src/images` folder, and rendered using the `OptimizedImage` component. To render an image in the `src/image` folder, you'd have to import the image using the following syntax:
332335
333-
`import atomicManiq from "@/public/images/atomic-dex-maniq.webp";`
336+
`import atomicManiq from "@/public/images/komodefi-maniq.webp";`
334337
335338
Now you can render the image using the `OptimizedImage` component, for example:
336339
337340
`<OptimizedImage title="Atomic Dex" src={atomicManiq} alt="atomic dex" classNaming="w-full" />`
338341
339-
![Atomic Maniq](style-guide-images/atomic-maniq.png)
342+
![Atomic Maniq](style-guide-images/komodefi-maniq.png)
340343
341344
<!-- [You can read more about the magic behind OptimizedImage](https://github.com/Niels-IO/next-image-export-optimizer#readme) -->
342345
File renamed without changes.

src/pages/komodo-defi-framework/tutorials/api-docker-telegram/index.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ export const title = "Get telegram notifications for your AtomicDEX LP";
22
export const description =
33
"This document describes how to become a Liquidity Provider for AtomicDEX with telegram notifications using docker.";
44

5-
import rickmorty from "@/public/images/atomicdex-api/tg-bot-rickmorty.png";
6-
import passphrase from "@/public/images/atomicdex-api/tg-bot-passphrase.png";
7-
import orderbook from "@/public/images/atomicdex-api/tg-RICKMORTYorderbook.png";
5+
import rickmorty from "@/public/images/api-images/tg-bot-rickmorty.png";
6+
import passphrase from "@/public/images/api-images/tg-bot-passphrase.png";
7+
import orderbook from "@/public/images/api-images/tg-RICKMORTYorderbook.png";
88

99
# How To Become a Liquidity Provider for AtomicDEX with Telegram Notifications using Docker
1010

src/pages/komodo-defi-framework/tutorials/api-metrics/index.mdx

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ export const title = "AtomicDEX Metrics";
22
export const description =
33
"Monitor and analyze the performance and activity of your AtomicDEX API sessions with various metrics.";
44

5-
import prometheus1 from "@/public/images/atomic-dex-tutorials/prometheus1.png";
6-
import graphana1 from "@/public/images/atomic-dex-tutorials/graphana1.png";
7-
import graphana2 from "@/public/images/atomic-dex-tutorials/graphana2.png";
8-
import graphana3 from "@/public/images/atomic-dex-tutorials/graphana3.png";
9-
import graphana4 from "@/public/images/atomic-dex-tutorials/graphana4.png";
10-
import graphana5 from "@/public/images/atomic-dex-tutorials/graphana5.png";
11-
import graphana6 from "@/public/images/atomic-dex-tutorials/graphana6.png";
12-
import graphana7 from "@/public/images/atomic-dex-tutorials/graphana7.png";
13-
import graphana8 from "@/public/images/atomic-dex-tutorials/graphana8.png";
14-
import graphana9 from "@/public/images/atomic-dex-tutorials/graphana9.png";
5+
import prometheus1 from "@/public/images/komodo-defi-framework-tutorials/prometheus1.png";
6+
import graphana1 from "@/public/images/komodo-defi-framework-tutorials/graphana1.png";
7+
import graphana2 from "@/public/images/komodo-defi-framework-tutorials/graphana2.png";
8+
import graphana3 from "@/public/images/komodo-defi-framework-tutorials/graphana3.png";
9+
import graphana4 from "@/public/images/komodo-defi-framework-tutorials/graphana4.png";
10+
import graphana5 from "@/public/images/komodo-defi-framework-tutorials/graphana5.png";
11+
import graphana6 from "@/public/images/komodo-defi-framework-tutorials/graphana6.png";
12+
import graphana7 from "@/public/images/komodo-defi-framework-tutorials/graphana7.png";
13+
import graphana8 from "@/public/images/komodo-defi-framework-tutorials/graphana8.png";
14+
import graphana9 from "@/public/images/komodo-defi-framework-tutorials/graphana9.png";
1515

1616
# AtomicDEX Metrics
1717

File renamed without changes.
File renamed without changes.

utils/js/create_data_for_gpts.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function readFileAndAddContentToFIle(filePath, contentHolder) {
1919
contentHolder.content += fileContent;
2020
}
2121

22-
const pathsNames = [["", "all"], ["atomicdex", "atomicdex"], ["historical", "historical"], ["smart-chains", "smart-chains"], ["antara", "antara"], ["start-here", "start-here"], ["atomicdex/api", "komodefi-api/all-api"], ["atomicdex/api/legacy", "komodefi-api/legacy-api"], ["atomicdex/api/v20", "komodefi-api/v20-api"], ["atomicdex/api/v20-dev", "komodefi-api/v20-dev-api"]]
22+
const pathsNames = [["", "all"], ["komodo-defi-framework", "komodo-defi-framework"], ["historical", "historical"], ["smart-chains", "smart-chains"], ["antara", "antara"], ["start-here", "start-here"], ["komodo-defi-framework/api", "komodefi-api/all-api"], ["komodo-defi-framework/api/legacy", "komodefi-api/legacy-api"], ["komodo-defi-framework/api/v20", "komodefi-api/v20-api"], ["komodo-defi-framework/api/v20-dev", "komodefi-api/v20-dev-api"]]
2323

2424
for (let index = 0; index < pathsNames.length; index++) {
2525
const element = pathsNames[index];

0 commit comments

Comments
 (0)