🧑🏾‍🎨 Open source contributing foundations #1044

JFWooten4 · 2024-10-15T22:29:40Z

solving #799

@briwylde08 mentioned that "networks tabs you can't use .mdx at the end of the link" - but I'm unfamiliar with the nuances here 🤔

briwylde08 · 2024-10-21T20:09:12Z

Hey! Great job on proposing a contribution guideline section for the docs — this will be really helpful as we encourage more community involvement. I especially like the details around writing code examples, defining Stellar terms, and cross-referencing.

Some general feedback I have is on language in general.

I think the language could be clearer and more neutral to better suit developer documentation. For example, in the Code Examples section, you wrote:

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 translates code!

Instead, I’d suggest simplifying it to:

Here's how to write correctly-formatted code blocks in Markdown.

The goal is to make the language more straightforward and focused on practical guidance. I’d also recommend removing language like:

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.

This kind of language is too complex and opinionated for readers who are looking for clear and actionable guidance on contributing. I think we should aim for concise, clear, and direct phrasing to ensure it’s accessible for all contributors.

Again, I think this is a great start and I'm excited to get a contribution guide out there!

ElliotFriend · 2024-10-22T16:08:29Z

Great start @JFWooten4! As I'm thinking about what needs to be in the contribution guidelines, here are some "sections" that come to mind. You likely already have thought of (most of) these, but I'll just write them out for the sake of collaboration.

referencing other docs pages (i.e., *.mdx vs non-mdx files, and when to use which)
code example indentations (i.e., 4 spaces for python, 2 spaces for javascript, etc.) (ideally, we should have that codified in a prettier config or something)
how to use the custom react components (seems like you've already gotten that ball rolling pretty well)
how to run the formatting/linting scripts, when/why you should, and if you should commit everything or just the files you're working on.
handling certain characters to avoid markdown compilation errors (< for example will cause the compilation to fail, and it should be escaped like \<)
special-case source files for some pages (openapi specs, cli guides, etc.)

Again, great start! Glad to have this in the works!! Thanks again

Basic framing, requires personalization

JFWooten4 · 2024-11-04T21:20:49Z

@ElliotFriend @briwylde08 Thank you both so much for voicing your initial reactions to my very rought draft! 💜 I will implement these thoughts and more in due time, and then circle back. One last thing I was wondering, I noticed¹ that a lot of the pages use [link](./FILENAME.mdx) while a simpler syntax could use [link](FILENAME.mdx)—any opinionated preference on same-dir referencing?

This is an outlier example where it references a folder rather than it's README.mdx, but it's most common to see dot-slash introductions from my experience, which I think complicates the editing plaintext interpretation. If you just want to voice a quick reply, perhaps a 👍 for (./FILENAME.mdx) or a 🚀 for (FILENAME.mdx) might suffice? ↩

JFWooten4 · 2024-11-20T02:15:15Z

How do you two feel about simplifying Go type declarations when multiple parameters share the same type?¹²

In the limited context of Go functions, do you have a preference for using entirely explicit typedefs v. inheriting previous?

If it's a binary answer, perhaps a 🎉 for "defining all" (option B) or a ❤️ for "item grouping" (option A)?

In Go, you can group parameters of the same type to simplify function signatures: func addLiquidity(source *keypair.Full, maxReserveA, maxReserveB float64) {}³ (option A) ↩
Compare behavior to that in Java, whereby you must explicitly declare the type for each parameter, even if they share the same type: public static void addLiquidity(KeyPair source, String maxReserveA, String maxReserveB) {} (option B) ↩
Note the maxReserveA does not have a subsequent type defined, since it is assumed that it's a float64 when maxReserveB compiles. ↩

JFWooten4 · 2024-11-26T14:53:29Z

We'll also need to clarify heading trailing commas, sectional href names, and cutoff lengths.

No known existing community opinions or best practices on the java syntax per https://discord.com/channels/897514728459468821/966788672164855829/1314630372042084534 in re stellar#1044. I know some of the existing pages have been loosely casted, but there seem to be a lot of new users complaining about Docs examples not compiling or running locally given test data.

I understand there's more to do in `docs\data\READ_FIRST.md`, but I'm just not going to deal with that until stellar#1044

This way only runs the Husky pre-commit if you have yarn installed, which should help with stellar#1044 compatability, given those with write access can quickly (via bot?) run the formatting. i had a lot of problems with this three weeks ago when editing on an offline laptop that didn't have all the dependencies involved. Even though I was going to take care of the nuances on this main desktop here, I couldn't synch up my work to the branch, and thus it was hard to manually override the git commit checks.

No known existing community opinions or best practices on the java syntax per https://discord.com/channels/897514728459468821/966788672164855829/1314630372042084534 in re stellar#1044. I know some of the existing pages have been loosely casted, but there seem to be a lot of new users complaining about Docs examples not compiling or running locally given test data.

I understand there's more to do in `docs\data\READ_FIRST.md`, but I'm just not going to deal with that until stellar#1044

This way only runs the Husky pre-commit if you have yarn installed, which should help with stellar#1044 compatability, given those with write access can quickly (via bot?) run the formatting. i had a lot of problems with this three weeks ago when editing on an offline laptop that didn't have all the dependencies involved. Even though I was going to take care of the nuances on this main desktop here, I couldn't synch up my work to the branch, and thus it was hard to manually override the git commit checks.

* 🔁 Channel accounts: explain resolutions Page 1 of 6 * 🔁 Channel accounts: simplify narrative Page 1 of 6 * 🔁 Channel accounts: specify cards Page 1 of 6 * 🔁 Channel accounts: finalize visuals Page 1 of 6 * 🔁 Channel accounts: simplify narrative Page 1 of 6 * 🔁 Channel accounts: expand details Page 1 of 6 * 🔁 Channel accounts: hyperlinks, context - Starlight active, details confirmed with SDF at https://discord.com/channels/897514728459468821/907476473739354153/1259478260220301362 - Searching for src on global consensus data packet propogation for relevance in random submisison delay - Need to get hard reference for Protocol 20 one-txn-per-ledger limit * 🔁 Channel accounts: initial diagrams * 🔁 Channel accounts: reference configuration - Use 100px corner rounding * 🔁 Channel accounts: KaTeX formatting - First time working with this in mdx, pretty nice * 🔁 Channel accounts: context, links * 🔁 Channel accounts: conceptual images * 🔁 Channel accounts: simplify image * 🔁 Channel accounts: prioritize readability * 🔁 Channel accounts: overload example * 🔁 Channel accounts: configuration example * 🫴🏽 Claimable balances: first example * 🫴🏽 Claimable balances: second example Status diction in determinant per stellar/stellar-protocol#1504 * 🫴🏽 Claimable balances: third example * 🫴🏽 Claimable balances: expand precomputation * 🔎 Refresh: asset design considerations See stellar#864 * 🦞 Clawbacks: confer readable diction * 🦞 Clawbacks: minor example diction * 🦞 Clawbacks: format account names * 🦞 Clawbacks: format more names * 🦞 Clawbacks: apply name diction See stellar/stellar-protocol#1516 (comment) * 🦞 Clawbacks: translate preamble example * 🦞 Clawbacks: expand example one * 🦞 Clawbacks: translate next instances * 🦞 Clawbacks: continue example dev * 💱 Trading examples: add lumenaut * ⏬ Prep for GH sync * 💱 Trading examples: clarify narrative A lot more to explain here given common perspective, available at https://www.youtube.com/live/3AGhdiQeXE0?t=1800 * 💱 Trading examples: contextualize sources While I appreciate that the legacy dialogue around atomic swaps has been between chains, I respectfully submit that this is only because there's never before been a global ledger that could accurately account for a variety of assets in any meaningfully-scalable way. Swaps being "automatically cancelled" is a bit of a mathematical abstraction, but I can't think of another way to explain it simply. src: https://bitcointalk.org/index.php?topic=193281.0 * 🙌 Missed a reference link Can I just take a minute to say how mind-boggling it is that MtGox is referenced on the Wikipedia page for OBs? * 💱 Trading examples: sell offers * 💱 Trading examples: level two per user example * 💱 Trading examples: time & sales * 🔁 Clarify channel context links * 🔁 Further advance text flow * 🔁 Start last code examples We're walking through an example implementation for general understanding, but the efficient implementation here likely falls on the applicator. * 🔁 Remove random channel generation I just don't see why we need to explicitly walk through this in a relatively advanced guide. * 🔁 Rest of authorization example Not convinced we need to include txn submission for the third time. * 🔁 Remove adding channel custody * 🔁 Clear up last tasks * 🔁 Start state rotation example The higher fee assumes we want these executed in the same block, so let's bid for that. Also, since this is an advanced guide, I'm taking out the redundant/verbose tx timeouts. * 🔁 Temporary merge, nonfinal publication I've finally hit my breaking point and am upgrading to Ubuntu. Accordingly, I'm synching up my last local changes despite the reality that I've held these back for some time because most of the substance was moved to protocol discussion 1558. But thanks, reccomendation, and shoutout to Silence for dropping in with some stellar wisdom. 🤝🧙‍♂️🧠 * 🔗 Minimum compilation link requirements * 🖌️ Prettier compilation demo fixes * 🔁 Clarify base fee, miscellaneous 🤝🏻 * 👽 Translate java to JS * 🔁 Last example java & go * 🔁 Closing example explanation, diagrams * 🔁 Put back `set timeouts` * 🔁 Cleanup remaining frame items * 🔁 Comment active-tense transitive verbs * 🔁 Finalize the story flow * 🔁 Polish off minor syntax * 🔗 Remove depricated community link * 🔎 Clarify note on trustlines * 🫴🏽 Finish most cleaning up (still need to clarify on min/base fee syntax for 1044) * 🔗 Update simplified syntax reference * 🦞 Clean up final examples * 💱 Remove items explicitly moved Id. at link 2 * 💱 Remove duplicate placeholder drafts * 💱 Sidebar section intro description * 💱 First rewrite run through See public drafting at https://x.com/JFWooten4/status/1853966327318520003 * 💱 Clean up scaffolding leftovers - By the time this pull merges, the volume/trade approx should hit. - Fixed missing API doc structure MethodTable explainer. - Added Lumenauts video to SCP explainer for accessability. * 💱 Translate starting AMM preamble * 💱 Capital pool > liquidity pool Effectively all protocol 18 coverage references AMMs because AMMs are generally the more common industry term. While I appreciate that exact diction can be alluring (https://github.com/orgs/WhyDRS/discussions/21), might we scope the introductory page at least to explain rather than confuse readers? * 💱 Translate two AMM steps For diction in _Id_, _see also_ R282 at JFWooten4/free-markets@dba9447#r149283300 * 📍 Follow up on this * 💱 Translate removing AMM liquidity And simplify the go newTxBuilder preconditions * 💱 Translate Java wrap-up example Gives defereance to full disaply decimals rather than two-digit truncation. As an aside, are there any reputable anchors using display_digitals in their tomls? * 💱 Last legacy, 535b09b fix Addresses the logic combination and Go documentation. Since we're using it to build an obj to add ops to, signing should stay as is. * 💱 Clean up go conclusion * 📌 Simplify starting frame, independence * 💱 Seperate preliminary config, example I've been digging through the commit history to uncover the origins of some of the JS nesting before stellar#214... I'm updating them to be a little more responsive, readable, and reusable with async waits * 🖌️ Update prettier config note I was messing around with `prettier-plugin-sh` and figured the note could be more localized in case we add tabWidths or such later on here (albeit you can locally inspect the upstream import for equivalent affect) * 💱 Optimize, clarify global declarations It could be prudent to globalize the accounts so that we can walk through the other limit order examples * 💱 DEX code examples setup No known existing community opinions or best practices on the java syntax per https://discord.com/channels/897514728459468821/966788672164855829/1314630372042084534 in re stellar#1044. I know some of the existing pages have been loosely casted, but there seem to be a lot of new users complaining about Docs examples not compiling or running locally given test data. * 💱 Initial sell offer examples * 💱 Example resolving limit OB * 💱 Pricing point local calculation * 💱 Start prepping final flow * 💱 Continue on the intro Most of the present code exemplifications are done or should elsewise be refrenced in text and then relied upon for individual pages to have their own examples. * 💱 Start of execution chat Some more here dependent on XDR and propogation implementations, which are good for future scopes per https://discord.com/channels/897514728459468821/907476473739354153/1273021348628664433 * 💱 Migrate some ancillary points Relatively scope limited per https://github.com/JFWooten4/JFWooten4/blob/main/decisions/core-723-fn.md * 💱 Introduce the OB outreach Sort of like how this binds the AttriubteTable to its own scope, especially since it has the same background color. * 💱 Translate pricing calculation examples * 🐛 Reinstate space line seperators * 💱 Remove elementary explanation diction * 🖋 Some primative punctuation upgrades * ✏ Operations as complete(r) sentences * 📊 Upgrade Dashboard API version * 💱 First terminus run through * 💱 Second terminus run through * 💱 Small example bug TODOs * 🐛 compilation bug fixes, hrefs I understand there's more to do in `docs\data\READ_FIRST.md`, but I'm just not going to deal with that until stellar#1044 * 💱 Add pending relevant backlinks * 🐛yarn fixes, format checks This way only runs the Husky pre-commit if you have yarn installed, which should help with stellar#1044 compatability, given those with write access can quickly (via bot?) run the formatting. i had a lot of problems with this three weeks ago when editing on an offline laptop that didn't have all the dependencies involved. Even though I was going to take care of the nuances on this main desktop here, I couldn't synch up my work to the branch, and thus it was hard to manually override the git commit checks. * 🐜 Reformat the operations page Husky changes here should respect stellar#96 given the autochecks run formatter and fail if not prettier at `check MDX` step * 💱 narrative done; last technicals * 🤷‍♂️ a lot of prettier-ness * 💱 remove rest of politics * 💱 trim down until SD1545 * 💱 subsection for offerID resolution Also removes a lot of redundant language from the intent of d5ff964 * 🐞 Active tense on index also bypass the check if yarn run fails for reasons unrelated to file issues like Node version mismatch or corrupt environment * 💱 limited pathfiding explanation for example * 💱 Minimumm viable path payments This gets into how deeply we want to epxlain paths in stellar#1545 * 💱 setup for solo PP workj * 💱 simplify start off PP * 💱 PP; simplyifing path diction * 💱 Simply Liquidity Horizon Documentation This cleans up the wording around stellar#1061 without reviewing the pages we notify users about `consistency`. I think a better long-term solution is a "Consistency" flag added to the affected endpoint pages. This could be a simple button akin to the "Supports Streaming" info box. However, even that seems a verbose solution which would also do well to exist as a simple button (akin to ledgerStorage) > two sentences. * 💱 More context for burning prep --------- Co-authored-by: John Wooten <hello@blocktransfer.dev>

commit 6ded3bc Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Jun 9 17:22:59 2025 -0400 💱 More context for burning prep commit 756e630 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Jun 2 12:51:21 2025 -0400 💱 Simply Liquidity Horizon Documentation This cleans up the wording around stellar#1061 without reviewing the pages we notify users about `consistency`. I think a better long-term solution is a "Consistency" flag added to the affected endpoint pages. This could be a simple button akin to the "Supports Streaming" info box. However, even that seems a verbose solution which would also do well to exist as a simple button (akin to ledgerStorage) > two sentences. commit 29a8450 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Jun 1 09:08:29 2025 -0400 💱 PP; simplyifing path diction commit 35caba6 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Jun 1 08:42:57 2025 -0400 💱 simplify start off PP commit 6f0ff4f Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sat May 31 02:38:44 2025 -0400 💱 setup for solo PP workj commit c5e4c9e Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Wed May 28 19:18:11 2025 -0400 💱 Minimumm viable path payments This gets into how deeply we want to epxlain paths in stellar#1545 commit 876ac1e Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue May 27 21:41:36 2025 -0400 💱 limited pathfiding explanation for example commit 7a3892b Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu May 15 12:24:36 2025 -0400 🐞 Active tense on index also bypass the check if yarn run fails for reasons unrelated to file issues like Node version mismatch or corrupt environment commit f79b038 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu May 15 09:11:48 2025 -0400 💱 subsection for offerID resolution Also removes a lot of redundant language from the intent of d5ff964 commit 83a6843 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Wed May 14 10:13:18 2025 -0400 💱 trim down until SD1545 commit 987a5c0 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Wed May 14 01:19:03 2025 -0400 💱 remove rest of politics commit ffa8d2f Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue May 13 15:35:18 2025 -0400 🤷‍♂️ a lot of prettier-ness commit 7742311 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue May 13 15:23:17 2025 -0400 💱 narrative done; last technicals commit f18af8f Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Apr 20 14:47:40 2025 -0400 🐜 Reformat the operations page Husky changes here should respect stellar#96 given the autochecks run formatter and fail if not prettier at `check MDX` step commit 788a8a0 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Apr 20 13:42:42 2025 -0400 🐛yarn fixes, format checks This way only runs the Husky pre-commit if you have yarn installed, which should help with stellar#1044 compatability, given those with write access can quickly (via bot?) run the formatting. i had a lot of problems with this three weeks ago when editing on an offline laptop that didn't have all the dependencies involved. Even though I was going to take care of the nuances on this main desktop here, I couldn't synch up my work to the branch, and thus it was hard to manually override the git commit checks. commit 322dafa Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Apr 7 21:45:12 2025 -0400 💱 Add pending relevant backlinks commit f511818 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Apr 7 17:25:08 2025 -0400 🐛 compilation bug fixes, hrefs I understand there's more to do in `docs\data\READ_FIRST.md`, but I'm just not going to deal with that until stellar#1044 commit 5f4618e Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Wed Apr 2 16:50:28 2025 -0400 💱 Small example bug TODOs commit 6a56ece Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Wed Apr 2 15:27:15 2025 -0400 💱 Second terminus run through commit 590f3c6 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu Mar 27 08:02:35 2025 -0400 💱 First terminus run through commit c46e031 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Fri Jan 31 11:27:56 2025 -0500 📊 Upgrade Dashboard API version commit 49da8d1 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu Jan 16 20:09:46 2025 -0500 ✏ Operations as complete(r) sentences commit 92cdba1 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Dec 31 16:11:20 2024 -0500 🖋 Some primative punctuation upgrades commit cd44088 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Dec 31 17:50:26 2024 -0500 💱 Remove elementary explanation diction commit b49ee47 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Dec 31 18:29:36 2024 -0500 🐛 Reinstate space line seperators commit 608fd1c Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu Dec 12 19:12:20 2024 -0500 💱 Translate pricing calculation examples commit 3b1697e Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu Dec 12 17:42:30 2024 -0500 💱 Introduce the OB outreach Sort of like how this binds the AttriubteTable to its own scope, especially since it has the same background color. commit 6f66c0a Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu Dec 12 16:41:55 2024 -0500 💱 Migrate some ancillary points Relatively scope limited per https://github.com/JFWooten4/JFWooten4/blob/main/decisions/core-723-fn.md commit a306040 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Thu Dec 12 15:09:46 2024 -0500 💱 Start of execution chat Some more here dependent on XDR and propogation implementations, which are good for future scopes per https://discord.com/channels/897514728459468821/907476473739354153/1273021348628664433 commit 1d8e302 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Dec 10 22:25:32 2024 -0500 💱 Continue on the intro Most of the present code exemplifications are done or should elsewise be refrenced in text and then relied upon for individual pages to have their own examples. commit 2b6cdf4 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Dec 10 18:26:41 2024 -0500 💱 Start prepping final flow commit b2f8ffa Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Dec 8 19:44:43 2024 -0500 💱 Pricing point local calculation commit d83acdf Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Dec 8 18:14:00 2024 -0500 💱 Example resolving limit OB commit 570b511 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Dec 8 17:58:06 2024 -0500 💱 Initial sell offer examples commit 0e51903 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Dec 8 09:18:15 2024 -0500 💱 DEX code examples setup No known existing community opinions or best practices on the java syntax per https://discord.com/channels/897514728459468821/966788672164855829/1314630372042084534 in re stellar#1044. I know some of the existing pages have been loosely casted, but there seem to be a lot of new users complaining about Docs examples not compiling or running locally given test data. commit dcbdd52 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Nov 26 14:05:31 2024 -0500 💱 Optimize, clarify global declarations It could be prudent to globalize the accounts so that we can walk through the other limit order examples commit 35866ad Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Nov 26 08:39:09 2024 -0500 🖌️ Update prettier config note I was messing around with `prettier-plugin-sh` and figured the note could be more localized in case we add tabWidths or such later on here (albeit you can locally inspect the upstream import for equivalent affect) commit bfd425b Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Nov 25 15:21:25 2024 -0500 💱 Seperate preliminary config, example I've been digging through the commit history to uncover the origins of some of the JS nesting before stellar#214... I'm updating them to be a little more responsive, readable, and reusable with async waits commit 080f16e Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Nov 24 16:19:16 2024 -0500 📌 Simplify starting frame, independence commit 7a06e12 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Nov 24 16:10:19 2024 -0500 💱 Clean up go conclusion commit c2aa855 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Nov 24 15:58:41 2024 -0500 💱 Last legacy, 535b09b fix Addresses the logic combination and Go documentation. Since we're using it to build an obj to add ops to, signing should stay as is. commit eeef13c Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Nov 24 02:57:54 2024 -0500 💱 Translate Java wrap-up example Gives defereance to full disaply decimals rather than two-digit truncation. As an aside, are there any reputable anchors using display_digitals in their tomls? commit c2b1cac Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Nov 24 00:50:21 2024 -0500 💱 Translate removing AMM liquidity And simplify the go newTxBuilder preconditions commit b863bdf Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Nov 24 00:30:50 2024 -0500 📍 Follow up on this commit 46fe78f Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Nov 19 22:54:04 2024 -0500 💱 Translate two AMM steps For diction in _Id_, _see also_ R282 at JFWooten4/free-markets@dba9447#r149283300 commit 95ab06c Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Nov 19 16:01:58 2024 -0500 💱 Capital pool > liquidity pool Effectively all protocol 18 coverage references AMMs because AMMs are generally the more common industry term. While I appreciate that exact diction can be alluring (https://github.com/orgs/WhyDRS/discussions/21), might we scope the introductory page at least to explain rather than confuse readers? commit 8137214 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Nov 18 22:37:51 2024 -0500 💱 Translate starting AMM preamble commit 4b00f80 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Nov 18 22:02:25 2024 -0500 💱 Clean up scaffolding leftovers - By the time this pull merges, the volume/trade approx should hit. - Fixed missing API doc structure MethodTable explainer. - Added Lumenauts video to SCP explainer for accessability. commit 5750f43 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Nov 5 21:34:25 2024 -0500 💱 First rewrite run through See public drafting at https://x.com/JFWooten4/status/1853966327318520003 commit c66aa3f Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Nov 5 14:54:40 2024 -0500 💱 Sidebar section intro description commit 48f2bb4 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Nov 5 14:54:20 2024 -0500 💱 Remove duplicate placeholder drafts commit 8774600 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Nov 4 22:29:05 2024 -0500 💱 Remove items explicitly moved Id. at link 2 commit 6316b03 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Nov 4 17:06:08 2024 -0500 🦞 Clean up final examples commit 36fb92d Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Nov 4 17:00:20 2024 -0500 🔗 Update simplified syntax reference commit 2ad87b8 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Mon Nov 4 16:28:14 2024 -0500 🫴🏽 Finish most cleaning up (still need to clarify on min/base fee syntax for 1044) commit b8b52f8 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Oct 27 11:18:57 2024 -0400 🔎 Clarify note on trustlines commit d3a8019 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Sun Oct 27 11:11:48 2024 -0400 🔗 Remove depricated community link commit b19956a Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Oct 22 22:03:30 2024 -0400 🔁 Polish off minor syntax commit 5664f97 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Oct 22 21:53:46 2024 -0400 🔁 Finalize the story flow commit 5c813a6 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Oct 22 21:25:30 2024 -0400 🔁 Comment active-tense transitive verbs commit f6cd6de Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Oct 22 21:23:43 2024 -0400 🔁 Cleanup remaining frame items commit d26922a Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Oct 22 19:25:01 2024 -0400 🔁 Put back `set timeouts` commit f8060be Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Oct 22 19:04:49 2024 -0400 🔁 Closing example explanation, diagrams commit 8c363b1 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Tue Oct 22 15:15:33 2024 -0400 🔁 Last example java & go commit a856022 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Fri Oct 18 20:53:00 2024 -0400 👽 Translate java to JS commit d9a82c2 Author: john.xlm <60260750+JFWooten4@users.noreply.github.com> Date: Wed Oct 16 18:49:31 2024 -0400 🔁 Clarify base fee, miscellaneous 🤝🏻 commit 5e8ecf2 Author: john.xlm <john.wooten@blocktransfer.com> Date: Tue Oct 15 19:14:16 2024 +0000 🖌️ Prettier compilation demo fixes commit ab1de20 Author: john.xlm <john.wooten@blocktransfer.com> Date: Tue Oct 15 19:13:16 2024 +0000 🔗 Minimum compilation link requirements commit 19d2e51 Author: John Wooten <john.wooten@blocktransfer.com> Date: Fri Oct 11 16:44:45 2024 -0400 🔁 Temporary merge, nonfinal publication I've finally hit my breaking point and am upgrading to Ubuntu. Accordingly, I'm synching up my last local changes despite the reality that I've held these back for some time because most of the substance was moved to protocol discussion 1558. But thanks, reccomendation, and shoutout to Silence for dropping in with some stellar wisdom. 🤝🧙‍♂️🧠 commit 7dff502 Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Oct 7 19:05:25 2024 -0400 🔁 Start state rotation example The higher fee assumes we want these executed in the same block, so let's bid for that. Also, since this is an advanced guide, I'm taking out the redundant/verbose tx timeouts. commit 1d7ed4d Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Oct 7 16:27:00 2024 -0400 🔁 Clear up last tasks commit 5ae7a16 Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Oct 7 16:09:29 2024 -0400 🔁 Remove adding channel custody commit 360be72 Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Oct 7 16:01:07 2024 -0400 🔁 Rest of authorization example Not convinced we need to include txn submission for the third time. commit 5fe6e23 Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Oct 7 14:13:59 2024 -0400 🔁 Remove random channel generation I just don't see why we need to explicitly walk through this in a relatively advanced guide. commit 3023ab8 Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Oct 7 14:13:20 2024 -0400 🔁 Start last code examples We're walking through an example implementation for general understanding, but the efficient implementation here likely falls on the applicator. commit dc0e3ae Author: John Wooten <john.wooten@blocktransfer.com> Date: Thu Oct 3 20:00:14 2024 -0400 🔁 Further advance text flow commit 2535889 Author: John Wooten <john.wooten@blocktransfer.com> Date: Tue Oct 1 19:09:16 2024 -0400 🔁 Clarify channel context links commit 39069be Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Sep 16 17:12:17 2024 -0400 💱 Trading examples: time & sales commit d572432 Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Sep 16 15:58:44 2024 -0400 💱 Trading examples: level two per user example commit 77ea7d4 Author: John Wooten <john.wooten@blocktransfer.com> Date: Mon Sep 16 14:05:17 2024 -0400 💱 Trading examples: sell offers commit 95d20e5 Author: john.xlm <hi@jfwooten4.com> Date: Fri Sep 13 14:07:12 2024 -0400 🙌 Missed a reference link Can I just take a minute to say how mind-boggling it is that MtGox is referenced on the Wikipedia page for OBs? commit 36edfb2 Author: john.xlm <hi@jfwooten4.com> Date: Fri Sep 13 12:32:55 2024 -0400 💱 Trading examples: contextualize sources While I appreciate that the legacy dialogue around atomic swaps has been between chains, I respectfully submit that this is only because there's never before been a global ledger that could accurately account for a variety of assets in any meaningfully-scalable way. Swaps being "automatically cancelled" is a bit of a mathematical abstraction, but I can't think of another way to explain it simply. src: https://bitcointalk.org/index.php?topic=193281.0 commit 3515321 Author: john.xlm <hi@jfwooten4.com> Date: Fri Sep 13 10:01:29 2024 -0400 💱 Trading examples: clarify narrative A lot more to explain here given common perspective, available at https://www.youtube.com/live/3AGhdiQeXE0?t=1800 commit 175a710 Author: John Wooten <hello@blocktransfer.dev> Date: Mon Aug 12 15:24:38 2024 -0400 ⏬ Prep for GH sync commit 8649beb Author: John Wooten <hello@blocktransfer.dev> Date: Thu Aug 8 10:03:11 2024 -0400 💱 Trading examples: add lumenaut commit c424d28 Author: John Wooten <hello@blocktransfer.dev> Date: Tue Aug 6 13:28:46 2024 -0400 🦞 Clawbacks: continue example dev commit 26b8a3b Author: John Wooten <hello@blocktransfer.dev> Date: Tue Aug 6 09:51:53 2024 -0400 🦞 Clawbacks: translate next instances commit 89a1717 Author: John Wooten <hello@blocktransfer.dev> Date: Tue Aug 6 08:10:55 2024 -0400 🦞 Clawbacks: expand example one commit dcd3de5 Author: John Wooten <hello@blocktransfer.dev> Date: Tue Aug 6 07:47:33 2024 -0400 🦞 Clawbacks: translate preamble example commit 09cb907 Author: John Wooten <hello@blocktransfer.dev> Date: Mon Aug 5 16:20:49 2024 -0400 🦞 Clawbacks: apply name diction See stellar/stellar-protocol#1516 (comment) commit a0aa3db Author: John Wooten <hello@blocktransfer.dev> Date: Mon Aug 5 14:39:06 2024 -0400 🦞 Clawbacks: format more names commit 93ca2fe Author: John Wooten <hello@blocktransfer.dev> Date: Mon Aug 5 11:56:08 2024 -0400 🦞 Clawbacks: format account names commit 3a96fd0 Author: John Wooten <hello@blocktransfer.dev> Date: Mon Aug 5 11:46:14 2024 -0400 🦞 Clawbacks: minor example diction commit 944885e Author: John Wooten <hello@blocktransfer.dev> Date: Sun Aug 4 21:06:55 2024 -0400 🦞 Clawbacks: confer readable diction commit ebf9cf9 Author: John Wooten <hello@blocktransfer.dev> Date: Sun Aug 4 20:46:28 2024 -0400 🔎 Refresh: asset design considerations See stellar#864 commit e03b03b Author: John Wooten <hello@blocktransfer.dev> Date: Fri Aug 2 12:45:07 2024 -0400 🫴🏽 Claimable balances: expand precomputation commit 12c058e Author: John Wooten <hello@blocktransfer.dev> Date: Mon Jul 29 18:03:38 2024 -0400 🫴🏽 Claimable balances: third example commit 7d960c3 Author: John Wooten <hello@blocktransfer.dev> Date: Mon Jul 29 17:16:25 2024 -0400 🫴🏽 Claimable balances: second example Status diction in determinant per stellar/stellar-protocol#1504 commit 76f74f5 Author: John Wooten <john.wooten@blocktransfer.com> Date: Thu Jul 18 12:50:14 2024 -0400 🫴🏽 Claimable balances: first example commit 306a5b0 Author: John Wooten <hello@blocktransfer.dev> Date: Sun Jul 14 20:02:34 2024 -0400 🔁 Channel accounts: configuration example commit 5329520 Author: John Wooten <john.wooten@blocktransfer.com> Date: Sun Jul 14 13:25:21 2024 -0400 🔁 Channel accounts: overload example commit 6c9122a Author: John Wooten <hello@blocktransfer.dev> Date: Sun Jul 14 13:20:45 2024 -0400 🔁 Channel accounts: prioritize readability commit ccd04c2 Author: John Wooten <john.wooten@blocktransfer.com> Date: Fri Jul 12 11:50:32 2024 -0400 🔁 Channel accounts: simplify image commit 2612753 Author: John Wooten <john.wooten@blocktransfer.com> Date: Fri Jul 12 11:49:52 2024 -0400 🔁 Channel accounts: conceptual images commit 4c7f4f4 Author: John Wooten <john.wooten@blocktransfer.com> Date: Wed Jul 10 17:42:19 2024 -0400 🔁 Channel accounts: context, links commit b4bcedc Author: John Wooten <hello@blocktransfer.dev> Date: Wed Jul 10 08:55:06 2024 -0400 🔁 Channel accounts: KaTeX formatting - First time working with this in mdx, pretty nice commit e238cb8 Author: John Wooten <hello@blocktransfer.dev> Date: Tue Jul 9 17:00:00 2024 -0400 🔁 Channel accounts: reference configuration - Use 100px corner rounding commit 20f78fe Author: John Wooten <john.wooten@blocktransfer.com> Date: Tue Jul 9 16:28:45 2024 -0400 🔁 Channel accounts: initial diagrams commit 56af589 Author: John Wooten <john.wooten@blocktransfer.com> Date: Sun Jul 7 18:16:12 2024 -0400 🔁 Channel accounts: hyperlinks, context - Starlight active, details confirmed with SDF at https://discord.com/channels/897514728459468821/907476473739354153/1259478260220301362 - Searching for src on global consensus data packet propogation for relevance in random submisison delay - Need to get hard reference for Protocol 20 one-txn-per-ledger limit commit e982afc Author: John Wooten <hello@blocktransfer.dev> Date: Wed Jun 26 10:09:53 2024 -0400 🔁 Channel accounts: expand details Page 1 of 6 commit f91a561 Author: John Wooten <hello@blocktransfer.dev> Date: Wed Jun 26 09:14:32 2024 -0400 🔁 Channel accounts: simplify narrative Page 1 of 6 commit 5ef566e Author: John Wooten <hello@blocktransfer.dev> Date: Sun Jun 23 13:49:52 2024 -0400 🔁 Channel accounts: finalize visuals Page 1 of 6 commit 858060f Author: John Wooten <hello@blocktransfer.dev> Date: Sun Jun 23 12:21:30 2024 -0400 🔁 Channel accounts: specify cards Page 1 of 6 commit ce6689f Author: John Wooten <hello@blocktransfer.dev> Date: Sat Jun 22 19:16:07 2024 -0400 🔁 Channel accounts: simplify narrative Page 1 of 6 commit 1da55ff Author: John Wooten <hello@blocktransfer.dev> Date: Thu Jun 20 07:55:14 2024 -0500 🔁 Channel accounts: explain resolutions Page 1 of 6

This was discussed in documentation work at stellar/stellar-docs#1044 (comment)

John Wooten and others added 4 commits October 25, 2023 14:26

Update liquidity-on-stellar-sdex-liquidity-pools.mdx

665cb75

Merge branch 'main' of https://github.com/JFWooten4/stellar-docs

fa6c87a

Start new CONTRIBUTING formalization

8490c61

Clarify a few repetitions

585940a

JFWooten4 mentioned this pull request Oct 16, 2024

📝 Refresh six classic guides #723

Draft

JFWooten4 mentioned this pull request Oct 23, 2024

📃 quite a few nested JFWooten4/stellar-docs#2

Open

Add Docusaurus markdown features

f992705

Basic framing, requires personalization

JFWooten4 mentioned this pull request Nov 26, 2024

🖌️ Minor publishing code syntax #1099

Merged

JFWooten4 mentioned this pull request Jan 16, 2025

Update README.md WhyDRS/.github#19

Merged

JFWooten4 added a commit to JFWooten4/stellar-docs that referenced this pull request Apr 7, 2025

🐛 compilation bug fixes, hrefs

598fa8b

I understand there's more to do in `docs\data\READ_FIRST.md`, but I'm just not going to deal with that until stellar#1044

JFWooten4 added 2 commits May 13, 2025 16:07

🖌 pending info - custom linking

4652e02

give examples for all Admonitions

d17a693

ElliotFriend pushed a commit to ElliotFriend/stellar-docs that referenced this pull request Aug 8, 2025

🐛 compilation bug fixes, hrefs

f511818

I understand there's more to do in `docs\data\READ_FIRST.md`, but I'm just not going to deal with that until stellar#1044

JFWooten4 added a commit to JFWooten4/stellar-protocol that referenced this pull request Oct 20, 2025

Standard file reference path

c96ca2a

This was discussed in documentation work at stellar/stellar-docs#1044 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

🧑🏾‍🎨 Open source contributing foundations #1044

🧑🏾‍🎨 Open source contributing foundations #1044

Uh oh!

JFWooten4 commented Oct 15, 2024 •

edited

Loading

Uh oh!

briwylde08 commented Oct 21, 2024 •

edited by ElliotFriend

Loading

Uh oh!

ElliotFriend commented Oct 22, 2024

Uh oh!

JFWooten4 commented Nov 4, 2024 •

edited

Loading

Uh oh!

JFWooten4 commented Nov 20, 2024

Uh oh!

JFWooten4 commented Nov 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

🧑🏾‍🎨 Open source contributing foundations #1044

Are you sure you want to change the base?

🧑🏾‍🎨 Open source contributing foundations #1044

Uh oh!

Conversation

JFWooten4 commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

briwylde08 commented Oct 21, 2024 • edited by ElliotFriend Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ElliotFriend commented Oct 22, 2024

Uh oh!

JFWooten4 commented Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Footnotes

Uh oh!

JFWooten4 commented Nov 20, 2024

Footnotes

Uh oh!

JFWooten4 commented Nov 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JFWooten4 commented Oct 15, 2024 •

edited

Loading

briwylde08 commented Oct 21, 2024 •

edited by ElliotFriend

Loading

JFWooten4 commented Nov 4, 2024 •

edited

Loading