Commit Graph

177 Commits

Author SHA1 Message Date
ddawson
757bfd4c07 Resubmit Python2 updates 2023-09-05 13:58:05 -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
mDuo13
cd2bd347d5 Use delivered_amount in JS browser wallet tutorial (Fix #2075) 2023-08-30 13:12:56 -07:00
Dennis Dawson
aa71d90bca Merge pull request #1911 from XRPLF/pythonQuickstart
Quickstart Python draft
2023-06-23 11:31:18 -07:00
ddawson
73679228b4 Update screenshots 2023-06-08 14:49:26 -07:00
Morgan Bergen
96f6f96b43 Update ecosystem.svg
Formally called ripple-lib, but now called xrpl.js
2023-06-05 17:35:24 -05:00
ddawson
ec98916a09 Add 3 tutorials 2023-06-01 14:17:57 -07:00
oeggert
cd47cc9830 Merge pull request #1699 from XRPLF/propose-amendment-tutorial
Add Contribute Code Topic
2023-05-26 15:55:45 -07:00
Oliver Eggert
53d563035f update dactyl redirects and update flowchart 2023-05-24 21:21:13 -07:00
Dennis Dawson
ba6ca26637 Merge pull request #1800 from XRPLF/add_tut_guide
Add tut guide
2023-05-19 16:45:35 -07:00
ddawson
ace77f4660 Quickstart Python draft 2023-05-17 17:26:37 -07:00
Rome Reginelli
e34f530946 Merge pull request #1866 from XRPLF/docs-homepage-update
Docs.html page update
2023-05-17 14:54:38 -07:00
Caleb Kniffen
964ef25caa Added trans tags, renamed files, bumped css version 2023-05-15 15:54:49 -05:00
Oliver Eggert
080b7562b8 Add flowchart 2023-05-11 15:57:33 -07:00
Tushar Pardhe
8c888bd248 Build a wallet using js - JS Bounty (#1752)
Created javascript tutorial with feedback from @mDuo13 and @JST5000 to teach folks how to build a wallet for the xrpl using javascript.
2023-05-09 16:52:21 -07:00
JST5000
8fb320da25 Fix image links 2023-05-09 16:48:01 -07:00
JST5000
56a20d4ef9 Align top background splash 2023-04-20 12:11:45 -05:00
JST5000
0ed03fdff8 Handle light mode in a consistent way 2023-04-20 12:11:45 -05:00
JST5000
0b80d73698 Start on light mode 2023-04-20 12:11:45 -05:00
JST5000
456f7f0c88 Complete dark mode flat card section 2023-04-20 12:11:45 -05:00
Amarantha Kulkarni
87178f3fcb Remove in-development docs for sidechains and EVM sidechains (#1863)
* Remove in-development docs for EVM sidechain and now obsolete content for federated sidechains dev preview

* Remove disclaimer note about EVM sidechain

* Remove references to sidechains which are in development

* Add redirects to deleted pages

* Incorporate feedback to comment out Issue Fields

* Fix broken links
2023-04-10 07:25:07 -07:00
ddawson
7450190438 Fix set minter, misc 2023-03-30 16:41:23 -07:00
ddawson
8a126afd0c Add Tutorial Guidelines 2023-03-06 16:31:23 -08:00
ddawson
e98f40c5c2 Add NFT Auction topic 2023-02-13 11:07:35 -08:00
mDuo13
ecb8acfafb Fix AMMDeposit formula 2022-11-22 20:04:30 -08:00
mDuo13
08bbcc4dd7 AMM reference docs
AMM object: some clarifications

AMM references: incomplete draft

AMM updates

AMM: add AMMBid, clarify more stuff

Docs for AMMBid transaction

AMM: more work on error codes

AMM: example transactions, related upates

Fix broken links

AMM: reflect naming updates

more AMMBid edits

Add amm_info API method

Add style for AMM label

AMM: more clarifications on tx, accounts

AMM references: Clean up draft

amm_info: reflect code updates

AMM: updates for the latest changes

AMM: update flags for Deposit/Withdraw

AMM: update JSON examples for latest code

Serialization: add STIssue type

STIssue: clarify definition with commas
2022-11-21 22:40:12 -08:00
ddawson
0e9feb86c6 Remove NFT-Devnet refs, old tutorial 2022-11-15 13:52:41 -08:00
ddawson
30102e5152 Update tutorial for testnet 2022-11-14 17:45:08 -08:00
Amarantha Kulkarni
a87a06620c Initial migration and edits for EVM Sidechains documentation (#1544)
* Initial migration and edits for EVM Sidechains documentation

* Fix broken link

* Incorporate review feedback and fix indentaton for code snippets and images within steps

* Incorporate review feedback

* Fix indentation within steps
2022-10-17 18:33:33 -07:00
mDuo13
eb1cf15002 Add screenshots to dev tools
Card screenshots: round corners

Dev tools screenshots: update with no apex banner
2022-08-31 16:30:37 -07:00
Dennis Dawson
5765b15d91 Merge pull request #1483 from XRPLF/add-auth-minter
Add auth minter
2022-08-31 11:50:37 -07:00
ddawson
6ab35286dc add missing graphic 2022-08-30 11:10:26 -07:00
ddawson
ac3fe2e056 Add Authorized Minter to Quickstart 2022-08-30 09:53:28 -07:00
Jake
1ecdef8811 first pass funding page 2022-08-11 14:48:59 -07:00
Amarantha Kulkarni
6930657686 WIP - initial draft for Clio 2022-06-26 08:23:13 -07:00
Jake
bd7969cc69 Merge branch 'master' of https://github.com/JakeatRipple/xrpl-dev-portal into feat-ambassadors 2022-06-16 10:04:00 -07:00
Rome Reginelli
d3815908d5 Merge pull request #1411 from JakeatRipple/feat-community
Feat community
2022-06-15 13:14:56 -07:00
Jake
8ba14cbc95 First pass adding landing page 2022-06-07 19:50:13 -07:00
Dennis Dawson
39c9073775 Update and add screenshots 2022-06-01 18:22:41 -07:00
Jake
9d25765eaa First pass re org page 2022-04-24 17:51:26 -07:00
Dennis Dawson
b237fab197 Add renamed NFT broker graphics 2022-04-20 13:40:13 -07:00
Dennis Dawson
072154c5ec Remove and replace 2022-04-20 13:39:35 -07:00
Dennis Dawson
ac82e5bc65 Remove and replace 2022-04-20 13:39:08 -07:00
Dennis Dawson
021c4aac46 Supporting graphics for NFToken Transfer concept 2022-04-20 11:33:36 -07:00
Dennis Dawson
4eba1dff84 Screenshots for the XRPL Quickstart Tutorial 2022-04-13 14:48:52 -07:00
Rome Reginelli
79b4e54a6a Improve Docs for Decentralized Exchange (#1357)
* Decentralized Exchange concept article

1st draft

* DEX: example trade diagram, offers rewording

* Offers: more rewriting/updates

* OfferCreate: Add error cases + other updates

* Known Amendments: fix tecEXPIRED, DepositPreauth

- tecEXPIRED was initially attached to the Checks amendment but got
  moved to DepositPreauth before either became released. The docs weren't
  previously updated to reflect this change
- A change to the snippets caused the DepositPreauth amendment reference
  link to get overwritten so the table links to the feature page rather than the
  amendment description. Special cases this one link.

* OfferCreate error cases: switch to table

* DEX/Offers: edits per review
2022-03-21 08:11:13 -07:00
Jake
d73460e1c8 Merge branch 'master' of https://github.com/jakeatdocforce/ripple-dev-portal into events
# Conflicts:
#	assets/css/devportal2021-v6.css
#	styles/package.json
#	template/base.html.jinja
2022-03-10 17:21:30 -07:00
Rome Reginelli
27155b50ca Merge pull request #1344 from XRPLF/tokens_renaming
Rename "Issued Currencies" to Tokens
2022-03-02 16:52:54 -08:00
Jake
9b8022d162 Add fllters and light mode images 2022-03-01 16:48:57 -07:00
Amarantha Kulkarni
ed4de1838d Move content into subsections 2022-02-22 10:34:33 -08:00