Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEX Integration Docs #2401

Closed
wants to merge 264 commits into from
Closed

DEX Integration Docs #2401

wants to merge 264 commits into from

Conversation

oeggert
Copy link
Collaborator

@oeggert oeggert commented Feb 19, 2024

How-to guide to connect and trade on the XRPL DEX.

mDuo13 and others added 30 commits January 31, 2024 16:07
Script replacing include_code with code-snippet

Migration script: partials, some variables

Add variables to conversion script

draft repo-link component

Complete repo-link component

Migration script: handle github links

Draft include_svg→inline-svg (non-functional)

Currently doesn't work due to image path issues.
Also, captions and custom classes (for inlining) not implemented yet.

Conversion script: refactor & add code-page-name

Custom code-page-name component works around Markdoc limitation where
vars can't be used in `inline code` sections.

Migrate script: Handle more code includes correctly

Migration script: tabs and tabbed code samples

Child pages macro & conversion script

Adapted from 70cffa6

Migration script: update with some partial fixes

Migration script: callouts→admonitions

Fix auto-generation of index pages

Migration script: fix SVG migration

Migration scripting: fix code block prefixes & indentation

- Use the Redocly 0.66 feature for code block prefixes
- Update the script for converting indented code blocks to fences with
  Roman's latest fixes (now uses 4 spaces per level, for consistency)
* Get basic HTML loading for faucet page

* Add xrpl.js implementation

* Add sidebar and fix throbber

* Add translates

* Try to format sidebar

* Fix formatting

* Support xrpl.js

* Fix links

* Comment out XRPLGuard for now

* Make AMM Devnet faucet work

* Improve readability

* Update all instances of link + fix topnav

* Remove unnecessary file

* Use a more current version of xrpl

* Add missing loader while keys are generating

* Type with xrpl and remove unnecessary script

* Use string interpolation instead of multiple trans

* Move faucets into a json file

* Remove the old faucet code

* Use xrpl-beta directly

* Use dropsToXRP

* Support hooks natively

* Remove AMM-Devnet

* Revert changes to link path

* Revert link changes pt 2

* Revert pt 3

* Use XRPLoader for loading icon

* Fix small mistakes

* Remove unnecessary changes
Update convert-template

Add basic page

Add it to the sidebar

Fix a broken link

Fix translate usage and add linebreaks

Fix indents

Add basic sidebar

Port over init button logic

Migrate submit_and_notify and start dest addr

Get the payment button working

Componentize the Send XRP Payment button

Add basic escrow button

Componentize payment channel

Migrate Trust For

Migrate Send Issued Currency

Add partial payment progres bar logic

Use the component for the partial payment

Add support for escrow finish

Log transactions in sidebar

Debugging partial payment setup

Add support for changing destinationAddress

Finish adding bootstrap growl notifications

Use 'client' instead of 'api'

Move DestinationAddressInput to component and remove ids

Split the page into separate files

Remove the old files for this page

Update links

Add space

Add comment deprecating bootstrap-growl jquery

Fix typing errors

PR Comments Pt 1

Small PR fixes

Encapsulate isValidDestinationAddress
This will make development much easier by having all commands at the
project root. This also removes the deprecated `node-sass`

Fix build-css-watch
Updating redocly to latest and leveraging `@uiw/react-codemirror` which
it also uses.
Add tool/migrate.sh as a one-stop conversion script for the whole repo.
This script's duties include:

- Changing all links from their old (.html) paths to new paths
- Converting most Dactyl-specific syntax to Redocly equivalents
- Generating Redocly sidebar and redirects YAML files

This script is meant to be run from the repo top. It replaces syntax
in-place. Unless this is the final migration phase, the results of
running the migration script should be committed in a separate commit
whose message starts with '[DROP]' so it can be re-run on the latest
version of the master branch during rebasing.

Many commits have been squashed into this one, including:

- Add tool/migrate_links.sh as a one-stop conversion script for links.
- Enable the update_links filter in dactyl config but make it inactive
  unless you pass the appropriate vars
- Hack include_svg script to assume content/img instead of img

[FOLD] Migration scripting improvements:

- Roll scripting into all-in-one tool/migrate.sh
- Script moving/renaming Japanese snippets into @i18n
- Link replacment in snippets
- Handle links with query params
- Handle ref-links with anchors
- Remove some macro syntax that breaks Redocly
- Follow internal redirects in link replacement
- Handle links to some non-md pages

[FOLD] Migration script: handle more reflinks & imgs

[FOLD] tweak link migration

[FOLD] Fix substitution of reflinks

Add sidebar script

[FOLD] Fix link migration and whitespace noisiness

[FOLD] Link migration: auto-generate better link replacements

[FOLD] Convert badge syntax

[FOLD] Migration script: handle :not_enabled: syntax

[FOLD] Script generation of redirects

[FOLD] Migration script: make reusable common links

[FOLD] Fix common links code & conversion script comments

[FOLD] Add more non-md links

[FOLD] Fix filter_update_links syntax

[FOLD] Fix script's common links include placement

[FOLD] Migration script: update badge replacement to work w/ common-links

[FOLD] Fix ordering of converting common-links vs partials

[FOLD] Fix link substitution in common-links and fix trailing /index in redirects
The changes in this commit were auto-generated by running

tool/migrate.sh

Following this commit, the Dactyl build no longer works but the Redocly
build (mostly) should.
adds events page, updates convert-template script

adds proper filter logic to events page, adds moment

converts history page

converts impact and xrpl-ledger-overview page

try getting animation on impact to work

converts xrp overview page and logic

adds contribute page, still needs typeform integration and animations

converts developer funding page

adds dev tools page

add missing image

adds code samples py conversion to js

adds hook to read current theme, adds animations to impact page

adds careers animations

adds correct animations for contribute page

adds light mode v of animations on contribute page

adds animations to uses page

adds modal logos and uses modal logic

completes uses page

more changes

Fix casing issues with use case files

fix grid issue on uses
Some of the changes in #2295 are missing
amarantha-k and others added 25 commits February 27, 2024 09:38
fix links on code samples page
Now that Clio 2.1.0 has been released, we want to make sure this info is updated in the api methods.

Ports changes made in this draft [PR](#2337).

I will close that draft once this is merged.
[JA] update NFTokenAcceptOffer page
AMM transaction types in account_tx (Clio)
@oeggert oeggert mentioned this pull request Mar 1, 2024
@oeggert
Copy link
Collaborator Author

oeggert commented Mar 1, 2024

Closing this PR. Refer to #2433

@oeggert oeggert closed this Mar 1, 2024
@oeggert oeggert deleted the dex-integration branch March 1, 2024 17:38
@tequdev tequdev removed the needs japanese translation PRs with English changes that need to be added/updated in the Japanese translation of the site label Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.