Commit Graph

66 Commits

Author SHA1 Message Date
ddawson
ab146f40a8 Reorg tokens & stablecoin use case
wip

fix links

fix 2 links

trim and add topics

Add checklist, rename sc subtopics

Fix internal links

Add DEX/AMM

Add graphics

reorg files

reorg/rename

Fix blurb

Remove old JA files

edits per review

review changes

rename output file name of index files to match the folder name

Update output file and parent filenames

add reusable links snippet

fix broken links

Update Ja file

Move path.md to same location in i18n folder

Revert naming for nft-collections page

Rename to match files in En and Ja

update links to reflect updated file name

Rename nft-auctions under Ja folder and update links throughout

Rename nftoken-authorized-minting and update links throughout

Fix links

Rename the nft-fixed-supply Ja file to match the reorg in English  and update links

Move nft-reserve-requirements file in Ja and update links

Fix some more broken links

Fix more broken links by renaming html files back

Stablecoin reorg: fix various issues

Remove nfts_by_issuer method (unreleased) page

Remove redundant parent: attrs from config file

Fix syntax highlighting of Authorizing Another Minter js

Fix config/frontmatter errors
2023-12-06 17:21:23 -08:00
mDuo13
b37bccdbfb Fix AMM asset restrictions (no LP tokens) 2023-10-30 17:05:58 -07:00
mDuo13
838225f798 Add line breaks after initial h1's consistently 2023-10-16 16:30:34 -07:00
Rome Reginelli
6454f28425 Edits per @amarantha-k review
Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>
2023-09-12 15:07:03 -07:00
mDuo13
fd273dccb8 Fix interactive tutorial faucet interface on Devnet; migrate AMM tutorial to Devnet 2023-09-08 14:29:53 -07:00
mDuo13
3437ee9fe2 'Create AMM' tutorial: add to build 2023-09-08 14:29:53 -07:00
mDuo13
98e95a9629 Update built-in xrpl.js version 2023-09-08 14:29:53 -07:00
mDuo13
7b94d3edee Add create AMM tutorial
Add an interactive tutorial for creating an automated market maker,
updated with the latest changes from the Ripple Open Source site.
2023-09-08 14:29:53 -07:00
Rome Reginelli
b51bcb4ea3 Information Architecture v3 (#1934)
* Update look up escrows to remove redundant info about lookups via sender/destination. Modify cancel expired escrow for brevity.

* Cancel escrow: fix notes

* Add draft of updated cancel-escrow.js.

* Update intro to escrows.

* Add Escrow Tutorial

* Minor corrections

* Fix headings, add HTML

* Update escrow docs

This commit re-creates f205a92db2 with
some adjustments:

- Omit the accidentally-created dir full of junk
- Fix some typos and one mistake in the Escrow limitations section
- Add a table to the EscrowCreate ref to clarify valid combos of fields.

* Concept info from send-a-time-held-escrow added to escrow.md

* IA: Move "Consensus Network" files

This re-creates some work from the original commit 56fffe0b9f

* Rewrite escrows article (re-created)

This commit re-creates relevant work from the following commits:

9a4a588f2b Update escrow.md context info
e1b017dc83 Remove references to using escrow for interledger payments.

* IA: Move "XRPL servers" files

This re-creates some work from original commit 7611979abf

* IA: move "production readiness" files.

Re-creates work from the following commit:

692438693a  Move tutorials to concepts

* New intro articles

Original commit: 56fffe0b9f

* IA: Reorg account concepts

Re-creates some work from original commit 56fffe0b9f

* IA: reorg transaction concepts

Original commits:
9d4eff9940  WIP - reorg accounts
7611979abf  WIP dir. reorg

* IA: reorg consensus concepts

Original commit: 56fffe0b9f

* IA: Reorg ledger docs

Original commit: 56fffe0b9f

- Rephrased some details of the section

* IA: rename issuing/operational addresses page

Original commit: 56fffe0b9f

* Moving use cases

* Fleshing out Use Cases

Note, the dactyl-config.yml file has not been fully updated.

* Clean up checks conceptual info.

* Remove redundant checks use case section

Original commit: 3c29e9c05e

* IA: move Dex under tokens

Original commit: d08b3ba7d7

* Touch up stablecoin issuer use case (#1856)

* Consolidate stablecoin use case

* Stablecoin issuer: cleanup progress through sending

* Stablecoin issuer: reorg second half

(Note: the dactyl-config.yml is not fully reconciled yet)

* Move rippled and clio tutorials into infrastructure

* Remove link to checks amendement.

* Add note to account_objects.md about commandline interface type field.

* Merge expiration case with lifecycle section.

* Interoperability Use Cases

* Add graphics to intro

* Move escrow use cases to dedicated page.

* Update use case page intros and corresponding concept info.

* Clarify meaning of direct XRP payments.

* Intro link updates

* Payment use cases

* Remove some unnecessary links in transactions section

Original commit: e6fcf4a4dc

* Link cleanup in Tokens section

Original commit: 9588dd5e70

* Touch up 'Configure Peering' section

Original commit: fc8f0990b8

* Clean up links in accounts section

Original commit: 3da5fde7a8

* Add NFT mkt use case

* p2p payments: edits to Wallets

* Clean up payments use cases

* Refine history description

* IA: use case cleanup

* IA: reconcile servers, ledgers sections

* IA: reconcile payment types, tx, tokens

* IA: reconcile accounts section

* IA: reconcile infra

* IA: Fix most broken links

* Full Docs Index: omit from sidebar

* IA: fix up most broken links

* fix Absolute path link to internal content

* Quick updates to Software Ecosystem

* Remove some absolute links to internal resources

* Fix remaining broken links in JA target

* Contributing: tweak formatting

* Tutorials: fix some minor issues

* remove interop use cases

* remove intro image and personal references to dennis

* alphabetize-transaction-nav

* Remove unused files

* Add QS escrow tutorials

* IA: move ledgers, consensus protocol files around

* IA: update nav for new page hierarchy

* reordering of topics under new networks and servers top-nav

* Move "Naming" to "What is XRP?"

* Update dactyl-config.yml

Remove xrp.md from the TOC.

* Update list-xrp-as-an-exchange.md

Update link to what-is-xrp

* Update list-xrp-as-an-exchange.ja.md

Change link to what-is-xrp

* Update currency-formats.md

Change link to what-is-xrp

* Update currency-formats.ja.md

Change link to what-is-xrp

* Update cancel-an-expired-escrow.md

Change link to what-is-xrp

* Update paymentchannelfund.md

Change link to what-is-xml

* Update look-up-escrows.md

Change link to what-is-xrp

* Update tokens.md

change link to what-is-xrp

* Update use-payment-channels.md

* Update send-a-time-held-escrow.md

Update link to what-is-xml

* fix broken links

* Update parallel-networks.md

Change link to what-is-xml

* Update parallel-networks.ja.md

* Update invariant-checking.md

Remove link to xrp.html

* Update invariant-checking.ja.md

Remove link to xrp.html

* Update transaction-cost.md

Change link to what-is-xrp

* Update transaction-cost.ja.md

Change link to what-is-xrp

* Update send-a-conditionally-held-escrow.md

Change link to what-is-xrp

* Update stablecoin-issuer.md

Change link to what-is-xrp

* Update tokens.ja.md

Change link to what-is-xml

* Update autobridging.ja.md

Change link to what-is-xrp

* Update currency-formats.md

update text

* reorganize infrastructure nav section

* Update currency-formats.md

Try removing link altogether.

* Update currency-formats.ja.md

Remove link to what-is-xrp.html

* move commandline usage topic to infrastructure

* initial intro rewrite

* minor update to language

* IA.v3: rm Production Readiness

* Delete xrp.md

* Update xrp link in snippet

* Add redirect for old xrp.html URL

* Small edits to 'What is XRP?' article

* Add missing imgs

* XRP - copy edit per @DennisDawson

* restructure tutorials nav and pages

* fix broken links

* more broken link fixes

* Algo trading: 1st draft

* Algo trading: notes on taxes

* Algo trading: edits per review

* algo trading: fix broken link

* Ledger structure: rewrite for accuracy and clarity

* Update links to removed 'tree format' header

* Ledger Structure: Update diagrams

* Re-gen CSS for ledger structure changes

* Ledger structure: edits per review

* IA.v3: fix broken NFT links introduced by rebase

* Desktop Wallet (py): update little stuff

* Update some capacity/storage details

* contribute doc nav update

* fix image link in create diagram page

* IAv3: Fix 'Ledgers' blurb

* Update full history requirements with details from community members

* add reviewer suggestions

* Edits per @trippled review

* Apply suggestions from peer review

Co-authored-by: oeggert <117319296+oeggert@users.noreply.github.com>

* FH: reword file size limit note per review

* Update software ecosystem

* updates per review

* Minor tweaks to graphics

* fixTypos

* Update content/concepts/introduction/software-ecosystem.md

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>

* Update content/concepts/introduction/software-ecosystem.md

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>

* [JA] update AccountDelete cost

* custom transactors doc

* add doc to dactyl config

* [JA] fix NonFungibleTokensV1_1 amendment status

* [JA] update NFTokenOffer page

* Remove old, unused XRP article (#2039)

* add reviewer suggestions

* Add tooling to check for file/nav consistency

- From the repo top, run tool/check_file_consistency.py to look for
  Markdown files that exist in the "content/" directory but aren't used
  in the documentation.
- New "enforce_filenames" filter prints a warning to console when
  building, if a file's path and filename don't match expectations
  based on its place in the nav and top heading.

* File consistency checker: correctly handle filenames starting in _

* Remove unused old 'get started' and associated code

* Create Resources section & reorg some files

- Rename some files/folders based on their place in the nav
- Move a bunch of non-documentation stuff, and docs on contributing code
  and/or docs to the new "Resources" section.
- Known issue: nav spills into a second row on page widths between
  993px-1110px. To be fixed in a later CSS update, maybe along with
  making the Resources dropdown multi-column.

* Fix #2078 code tab bug

CSS not built yet, to reduce merge conflicts. Won't have any effect
until that happens.

* fix Transaction JSON

* [JA] translate contributing contents

* fix contributing-to-documentation parent

* fix contribute-code blurb

* Top nav: add cols for Resources, fix broken links

* CSS: fix top nav overflows

* Fix broken link from redirect not in JA target

* Top nav: add Infra to article types

* Update contrib info & rename intro file

* [ja] Update link to suggested first page to translate

* [ja] fix contribute docs organization

* Run private network with docker tutorial (#2065)

* [NO-ISSUE] Run private network with docker tutorial

Adds a tutorial page in the Infrastructure section on how to run a private XRPL network with Docker.

Please let me know if you think this is a useful page to include for developers, whether the steps are clear or not, and if you have suggestions on what can be added to it.

* Add minor link fixes and Japanese target

* Apply suggestions from code review

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>

* Add link to ripple-docker-testnet setup scripts in See Also section

* Update repo URL

---------

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>

* add intro gfx (#2036)

* add intro gfx

* Move graphic up

* Update some graphics with their revised versions

* Add updated version of the custodial vs non-custodial graphic

---------

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>
Co-authored-by: Amarantha Kulkarni <akulkarni@ripple.com>

* Update to reflect current UNL publishers

* [ja] update contributing

Co-authored-by: tequ <git@tequ.dev>

* Incorporate feedback on "What is XRP" page. (#2099)

* Add trademark info for XRP

* Revert section to previous state

* Fix broken link (#2101)

---------

Co-authored-by: Oliver Eggert <oeggert@ripple.com>
Co-authored-by: ddawson <dennis.s.dawson@gmail.com>
Co-authored-by: Maria Shodunke <mshodunke@ripple.com>
Co-authored-by: tequ <git@tequ.dev>
Co-authored-by: oeggert <117319296+oeggert@users.noreply.github.com>
Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>
Co-authored-by: develoQ <develoQ.jp@gmail.com>
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
Co-authored-by: Amarantha Kulkarni <akulkarni@ripple.com>
2023-09-01 12:40:18 -07:00
Rome Reginelli
5116247da7 Merge pull request #1933 from XRPLF/xrpl-py-2.0
feat: Update xrpl-dev-portal to use xrpl-py 2.0
2023-07-05 15:00:32 -07:00
JST5000
72cd29a9a8 Link to submit_and_wait instead of send_reliable_submission 2023-07-05 09:13:38 -07:00
9oelM
5cff7b11c5 Update outdated "ledger" key to "ledger_index" key 2023-06-23 21:19:30 +08:00
JST5000
676e75da16 send_reliable_submission -> submit_and_wait 2023-06-05 16:05:04 -07:00
Riku
4c0a2c7984 rename base-async 2023-03-09 08:28:06 +01:00
Riku
43eee76019 add python tabs to tutorial page 2023-03-09 08:28:06 +01:00
Riku
a2119f3581 add python prerequisites 2023-03-09 08:28:05 +01:00
Amarantha Kulkarni
845422da7f Add words from new features such as NFTs to the spell checker (#1615)
* Add words from new features such as NFTs to the spell checker

* Add more proper nouns and general purpose words

* Add more proper nouns and general purpose words

* Update to use backticks

* Update proper nouns and generic words

* Fix style for words based on style checker report

* Style/spelling fixes

* Fix links broken by style/spelling updates

* More edits for style

* Finish updates to get style checker to pass

Co-authored-by: mDuo13 <mduo13@gmail.com>
2022-12-15 14:29:32 -08:00
mDuo13
bc752f213d Enable include_code by default 2022-11-22 16:18:30 -08:00
ddawson
0e9feb86c6 Remove NFT-Devnet refs, old tutorial 2022-11-15 13:52:41 -08:00
mDuo13
4addf5996b Update NFT status 2022-10-31 14:52:40 -07:00
mDuo13
eb1cac593c Trade in the DEX: link sample code & add README 2022-05-19 16:23:34 -07:00
Rome Reginelli
7bd708345e Merge pull request #1396 from mDuo13/offer_tutorial_1
Interactive Tutorial: Trade in the Decentralized Exchange
2022-05-11 13:13:05 -07:00
mDuo13
0da1f6e8b6 Trade in the DEX: edits per review 2022-05-10 13:43:57 -07:00
Rome Reginelli
bed6d7309d DEX tutorial: apply suggestions from review
Co-authored-by: Jackson Mills <aim4math@gmail.com>
2022-04-22 16:54:09 -07:00
mDuo13
fab942396b DEX tutorial: fix broken link 2022-04-21 13:27:06 -07:00
mDuo13
bf166fffa1 Finish trade in the DEX tutorial draft 2022-04-19 19:55:41 -07:00
Dennis Dawson
638b6a4222 Updates for SField changes
tokenid -> nft_id
TokenID -> NFTokenID
TokenOffers -> NFTokenOffers
index -> nft_offer_index
2022-04-05 17:56:26 -07:00
itsocialist
3d58b9e4b0 Update issue-a-fungible-token.md
Correct grammar describing tutorial
2022-03-27 22:22:23 -04:00
mDuo13
c8e908d3f5 More DEX tutorial progress 2022-03-17 19:29:54 -07:00
mDuo13
38f0ac7760 DEX tutorial progress 2022-03-17 19:29:38 -07:00
mDuo13
eae54d1dd0 Trade in the DEX tutorial (WIP) 2022-03-16 19:37:31 -07:00
Omar Khan
89bc839a80 fix whitespace indentation 2022-03-10 17:08:12 -05:00
Omar Khan
fb22c495bb fix NFTokenCancelOffer code snippets 2022-03-08 13:24:44 -05:00
mDuo13
ca80f66efe Tokens renaming: more find-and-replace 2022-02-15 18:45:03 -08:00
Anurag
f2473dea4d Updated typo in burnToken() function description
`burnToken` instead of `getToken`
2022-01-14 03:47:48 +05:30
Elliot Lee
2273a51ef2 nftoken-tester-tutorial - add See Also links 2022-01-10 22:46:15 -08:00
mDuo13
bef2d8a20e NFT doc format cleanup 2022-01-10 18:20:21 -08:00
mDuo13
2da5a6beb7 more NFT tutorial fixes 2022-01-10 13:00:21 -08:00
mDuo13
130d8636ab Merge NFT doc fixes 2022-01-10 12:48:43 -08:00
mDuo13
3e8ecf2191 Fix variables for NFToken source link 2022-01-10 01:10:03 -08:00
mDuo13
2608c5264d Move NFToken tutorial to Use Tokens category 2022-01-10 01:03:20 -08:00
mDuo13
473f38329d Freeze/interactive tutorials: edits per reviews 2021-10-26 14:43:10 -07:00
mDuo13
7c6257c2d8 Freeze tutorials: fixes and cleanup
- Move JS code samples to JS folder (future-proofing for other
  languages)
- Make "Freeze a Trust Line" tutorial interactive
- Add necessary functionality to interactive_tutorial helper JS
- Rework freeze a trust line tutorial/code sample to make an incoming
  line from another address and make looking up trust lines a
  full-fledged step
2021-10-25 22:56:31 -07:00
mDuo13
afe6b6263d Make global freeze tutorial interactive 2021-10-22 15:44:45 -07:00
mDuo13
2f41ef9480 Make 'Enable No Freeze' interactive 2021-10-22 15:44:45 -07:00
mDuo13
84d540a122 xrpl.js 2.0 edits per review, more cleanup 2021-10-20 12:43:56 -07:00
mDuo13
ee927ebf94 xrpl.js 2.0: clean up issue a token examples 2021-10-20 11:39:43 -07:00
mDuo13
d13b1a6895 Freeze tutorials: remove TODOs for code samples 2021-10-20 01:59:52 -07:00
mDuo13
58ea2abc40 xrpl.js 2.0: remove more TODOs, cleanup set individual freeze 2021-10-20 01:50:18 -07:00
mDuo13
7cff4596cc xrpl.js 2.0: address feedback, fix many TODOs 2021-10-19 18:55:06 -07:00