Skip to content

Commit

Permalink
Merge pull request #137 from KomodoPlatform/dev
Browse files Browse the repository at this point in the history
  • Loading branch information
gcharang authored Sep 28, 2023
2 parents a886740 + 8ad1c58 commit 91402f1
Show file tree
Hide file tree
Showing 113 changed files with 2,789 additions and 2,033 deletions.
2 changes: 1 addition & 1 deletion STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Be mindful of any feedback you receive from users, and let it guide you to impro
- Each file should contain a code block with at least one example of how to make a complete request, including all required parameters.
- 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.
- 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.
- 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 `trezor_initialisation` folder contains documentation for all methods for initialisation and authentication with a Trezor hardware wallet.
- 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.
- 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.
- Where a method or parameter is deprecated, this should be communicated in the method heading or request parameters table.
- 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.
Expand Down
Loading

0 comments on commit 91402f1

Please sign in to comment.