From 665cb75eedc5ed2ecca523008e407d47072d9ae8 Mon Sep 17 00:00:00 2001 From: John Wooten Date: Wed, 25 Oct 2023 14:26:38 -0400 Subject: [PATCH 1/4] Update liquidity-on-stellar-sdex-liquidity-pools.mdx --- docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx b/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx index c1295201a..a3ea58256 100644 --- a/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx +++ b/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx @@ -21,7 +21,7 @@ An order book is a record of outstanding orders on a network, and each record si A couple of notes on order books on Stellar: - The term “offers” usually refers specifically to ask orders. In Stellar, however, all orders are stored as selling- i.e., the system automatically converts bids to asks. Because of this, the terms “offer” and “order” are used interchangeably in the Stellar ecosystem. -- Order books contain all orders that are not acceptable to parties on either side to make a trade. +- Order books contain all orders that are acceptable to parties on either side to make a trade. - Some assets will have a small or nonexistent order book between them. In these cases, Stellar facilitates path payments, which we’ll discuss later. To view an order book chart, see the [Order Book Wikipedia Page](https://en.wikipedia.org/wiki/Order_book). In addition, there are also plenty of video tutorials and articles out there that can help you understand how order books work in greater detail. From 8490c619ec52fd8e0886cad0f7cd749010849b62 Mon Sep 17 00:00:00 2001 From: "john.xlm" Date: Tue, 15 Oct 2024 18:24:23 -0400 Subject: [PATCH 2/4] Start new CONTRIBUTING formalization --- CONTRIBUTING.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b8e32d855 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,80 @@ +todo: +- insert network goals prudently +- consensus on base fee info +- extrapolate variable styles + +# Welcome to the Docs Contributing guidebook 🌌 + +An ever-expanding collection of common practices made up from community members like you! + +## Why Streamline? + +By agreeing on common formats for routine documentation, might we present a consistend, professional, and (most egalitarianly) approachable docs repo? That was the inspiration for starting this reference for both new and veteran contributors. + +## Overarching Perspective + +Let's very carefully implicate some of the ethos behind the community in an effort to distill _Balancing the World_'s humanitarian principles into something that's subtly nudging towards an empowering, creative, and inclusive readership tone. + +## Code Examples + +If you're technically inclined, example applications of documented functions can go a long way to further the network's understanding. Writing a quick snippet is an easy way to connect with developers, and the [local simulation](README.md#development) translates code! + +``` + + + +```python +example = True +`` + +```js +let example = true; +`` + +```java +boolean example = true; +`` + +```go +example := true +`` + +```dart +bool example = true; +`` + +```kotlin +val example = true +`` + +```rust +let example = true; +`` + + + +``` + +# Developed Conventions + +## Referencing Base Fees + +Options here are reccomindign `baseFee` or explicitly 100, which [has and more likely than not will](https://stellar.expert/explorer/public/protocol-history) change. Part of the thinking imo is the amount of code to change when decreasing. + +## Diction, Wording + +The biggest goal with standard wording is alinging common diction around a shared set of beliefs. Thus, through consistence, we might attract new developers most considerate of humanity's pressing financial challenges. + +### Stellar terms + +- We don't capitalize "network" in `Stellar network` +- ?? capitlize Network as standalone term ?? +- Don't capitalize `asset` or `anchor`[^astrodollar] + +## Cross-Referencing + +When linking between pages in the docs, we use the local (`../../page.mdx#section`) resolution convention rather than raw hyperlinks to the hosting webpage. The `.mdx` extension inclusion "[does something magical](https://docusaurus.io/docs/markdown-features/links)," says Elliot. 🪄 + +Relevantly, if you're referencing the summary or menu page for a subsection, it's likely the file you're looking for is in `parent/README.mdx` rather than `folder.mdx`. And of course + +[^astrodollar]: In code examples, it's common practice to use astroDollars (and astroPesos if two are needed) as generic tokens. From 585940a677fac4d1776b9babe83b8fd9eec30d81 Mon Sep 17 00:00:00 2001 From: "john.xlm" <60260750+JFWooten4@users.noreply.github.com> Date: Tue, 15 Oct 2024 18:39:17 -0400 Subject: [PATCH 3/4] Clarify a few repetitions --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8e32d855..544a0ce41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,11 +55,17 @@ let example = true; ``` +### Multiple Cases + +If you're editing a detailed guide with different example segments, it is common to import packages only in the first initializatiopn of your example. After, packages, variables, and constants can be implied as the reader scrolls further into the page. + # Developed Conventions ## Referencing Base Fees -Options here are reccomindign `baseFee` or explicitly 100, which [has and more likely than not will](https://stellar.expert/explorer/public/protocol-history) change. Part of the thinking imo is the amount of code to change when decreasing. +Options here are recominding `baseFee`[^abd] or explicitly 100, which [has (and more likely than not will)](https://stellar.expert/explorer/public/protocol-history) change. Part of the thinking imo is the amount of code to change when decreasing. + +[^abd]: Possibly as an abstraction, similar to not repeating package imports. ## Diction, Wording From f9927051ed255ab23df5d5ea01437d9102bca86a Mon Sep 17 00:00:00 2001 From: "john.xlm" <60260750+JFWooten4@users.noreply.github.com> Date: Sun, 3 Nov 2024 20:31:53 -0500 Subject: [PATCH 4/4] Add Docusaurus markdown features Basic framing, requires personalization --- CONTRIBUTING.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 544a0ce41..31e984515 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,3 +84,106 @@ When linking between pages in the docs, we use the local (`../../page.mdx#sectio Relevantly, if you're referencing the summary or menu page for a subsection, it's likely the file you're looking for is in `parent/README.mdx` rather than `folder.mdx`. And of course [^astrodollar]: In code examples, it's common practice to use astroDollars (and astroPesos if two are needed) as generic tokens. + +--- + +# Docusarus markdown features + +## Front Matter + +Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): + +```text title="my-doc.md" +// highlight-start +--- +id: my-doc-id +title: My document title +description: My document description +slug: /my-custom-url +--- +// highlight-end + +## Markdown heading + +Markdown text with [links](./hello.md) +``` + +## Links + +Regular Markdown links are supported, using url paths or relative file paths. + +```md +Let's see how to [Create a page](/create-a-page). +``` + +```md +Let's see how to [Create a page](./create-a-page.md). +``` + +**Result:** Let's see how to [Create a page](./create-a-page.md). + +## Images + +Regular Markdown images are supported. + +You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): + +```md +![Docusaurus logo](/img/docusaurus.png) +``` + +![Docusaurus logo](/img/docusaurus.png) + +You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: + +```md +![Docusaurus logo](./img/docusaurus.png) +``` + +## Code Blocks + +Markdown code blocks are supported with Syntax highlighting. + +````md +```jsx title="src/components/HelloDocusaurus.js" +function HelloDocusaurus() { + return

Hello, Docusaurus!

; +} +``` +```` + +```jsx title="src/components/HelloDocusaurus.js" +function HelloDocusaurus() { + return

Hello, Docusaurus!

; +} +``` + +## Admonitions + +Docusaurus has a special syntax to create admonitions and callouts: + +```md +:::tip My tip + +Use this awesome feature option + +::: + +:::danger Take care + +This action is dangerous + +::: +``` + +:::tip My tip + +Use this awesome feature option + +::: + +:::danger Take care + +This action is dangerous + +:::