Skip to content

Commit

Permalink
Merge pull request #97 from KomodoPlatform/dev
Browse files Browse the repository at this point in the history
  • Loading branch information
gcharang authored Aug 29, 2023
2 parents 412cda0 + 4e30df8 commit 7185dab
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Be mindful of any feedback you receive from users, and let it guide you to impro
- 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.
- 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.
- 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.
- 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)`.
- 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.
- Use bullet points and numbered lists to break up long paragraphs to make the content more readable.

## Syntax
Expand Down
2 changes: 1 addition & 1 deletion authors.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
},
"borngraced": {
"username": "borngraced",
"commit_emails": [],
"commit_emails": ["samiodev@icloud.com"],
"socials": {
"twitter": "",
"linkedin": ""
Expand Down

0 comments on commit 7185dab

Please sign in to comment.