Commit Graph

176 Commits

Author SHA1 Message Date
mDuo13
4eaa35e68d AMM refs: fix broken links 2023-09-07 14:52:56 -07:00
mDuo13
b6a1035776 Catch AMM refs up to date 2023-09-07 04:11:53 -07:00
mDuo13
6a52167b9d Restore previous AMM docs 2023-09-06 18:17:30 -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
310ad85dc6 feature method: doc new behavior re:obsolete amendments 2023-06-26 17:58:41 -07:00
mDuo13
15c21d68a8 Add version 1.11.0 2023-06-20 17:57:30 -07: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
tequ
1d983c3d83 [JA] concept interoperability 2023-03-20 14:12:16 +09:00
Amarantha Kulkarni
7615fdba53 Add disclaimer on EVM sidechains pages (#1821)
* Add note that the EVM sidechains is a PoC and for development purposes only

* Changed sent to send in last sentence.

* Incorporate peer feedback

---------

Co-authored-by: Dennis Dawson <Dennis.s.dawson@gmail.com>
2023-03-16 17:03:37 -07:00
oeggert
e782a0aa8e Merge branch 'master' into 1100-release-docs 2023-03-14 12:33:54 -07:00
oeggert
743c9349bd Merge pull request #1780 from XRPLF/xrpfees-1100-updates
Update docs for XRPFees amendment
2023-03-07 16:28:01 -08:00
oeggert
271bf0569c Merge pull request #1776 from XRPLF/accountset-1100-updates
Update docs for DisallowIncoming amendment.
2023-03-07 16:14:45 -08:00
Oliver Eggert
99122506ae Update response code. 2023-03-02 21:53:21 -08:00
Oliver Eggert
4231a35ae3 Add 1.10.0 release tag 2023-03-01 10:08:03 -08:00
Oliver Eggert
06c4c2d990 Update account flags for 1.10.0 DisallowIncoming amendment 2023-03-01 10:01:12 -08:00
Oliver Eggert
ffd57e749d Update docs for XRPFees amendment 2023-03-01 09:54:56 -08:00
develoQ
d659a6ea49 fix 2023-03-01 09:37:25 +09:00
develoQ
bdd633e192 fix space etc 2023-02-20 13:07:14 +09:00
mDuo13
f335de0a75 account_objects, book_offers, ledger: edit per @oeggert review 2023-01-25 17:57:17 -08:00
mDuo13
840845cb2b ledger, ledger_data: clarify type filtering 2023-01-24 19:02:34 -08:00
mDuo13
98a759f455 [DRAFT] updates to ledger_entry for AMM, type filter 2023-01-18 18:01:49 -08: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
Rome Reginelli
e3a6935cb2 Merge pull request #1541 from XRPLF/amm_ref
Automated Market Maker (XLS-30d) reference documentation
2022-11-23 14:33:21 -08:00
mDuo13
c2cc532242 server_info/state updates: edits per reviews 2022-11-23 12:40:16 -08:00
Rome Reginelli
572e0ab3c6 AMM: apply suggestions from review
Co-authored-by: oeggert <117319296+oeggert@users.noreply.github.com>
2022-11-21 22:42:30 -08:00
mDuo13
720a322892 AMM refs: more edits per reviews 2022-11-21 22:40:14 -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
mDuo13
3ed5d90519 Update server_info/state w/ reporting mode details
- Add reporting mode specific fields
- Mark peers field as omitted from reporting mode
- Fix "external" gRPC link in server modes page
- Update "Configure gRPC" tutorial to better reflect current status of
  gRPC in rippled

This commit fixes #1446.
2022-11-16 15:38:42 -08:00
mDuo13
4addf5996b Update NFT status 2022-10-31 14:52:40 -07:00
develoQ
c03ee24571 add Japanese translations of NFT-related pages
- fix NFTokenOffer JSON Type to use `Currency Amount` instead `object or string`
- incremental reserve to 2 XRP
- Corrected description of failure conditions at Direct Mode
-
2022-10-01 21:52:31 +09:00
Rome Reginelli
9eae2888ed Merge pull request #1522 from XRPLF/ka_20220920
Known Amendments & NFT fixes
2022-09-22 17:19:30 -07:00
mDuo13
a556b817c1 Known Amendments & NFT fixes
- Add new amendments to the Known Amendments page.
    (The URL for the 1.9.4 release notes is speculative; this release is
    expected to happen "soon")
- Link the relevant API methods from the NFT concept page
- Rewrite some parts of the NFT concept page to be more concept-like and
  less a list of reference details
- Update the status of the CryptoConditionsSuite amendment
2022-09-20 15:25:05 -07:00
Wo Jake
9a3dd326cd Remove $ from bash command 2022-09-17 07:22:09 +00:00
Rome Reginelli
b38a70ea48 Merge pull request #1447 from mDuo13/gg_fixes
Fix broken links and old terminology
2022-08-05 10:24:30 -07:00
mDuo13
8559202675 Fix #1434: contrast in DepositAuth table in light mode 2022-08-01 17:31:22 -07:00
mDuo13
636ae7d3a5 Update terminology of old gateway guide 2022-07-30 02:31:00 -07:00
mDuo13
3458809228 Rename API method categories 2022-06-28 04:09:37 -07:00
mDuo13
42117756c6 Rename rippled-api.html reference page 2022-06-28 03:45:56 -07:00
mDuo13
1a21f1dbd3 Update NFT disclaimer 2022-05-23 17:35:05 -07:00
mDuo13
9a626bcf8b Known Amendments: add ExpandedSignerList, fixNFTokenDirV1, NonFungibleTokensV1 2022-05-20 03:24:52 -07:00
Rome Reginelli
5a43219e17 Merge pull request #1220 from amarantha-k/xrpl-1191
Clarify that you can generate keys in any normal way
2022-05-19 16:52:54 -07:00
mDuo13
1ab63e9c1b Assign a regular key pair: apply tabs for all code types 2022-05-17 13:32:12 -07:00
mDuo13
9a09afdc69 [JA] fix links 2022-03-21 14:31:09 -07:00
develoQ
773947c5e9 fix: pointed out in the review 2022-03-16 21:33:55 +09:00
mDuo13
a01585becd Tokens renaming: more fixes 2022-02-16 19:18:53 -08:00
mDuo13
ca80f66efe Tokens renaming: more find-and-replace 2022-02-15 18:45:03 -08:00
mDuo13
a6d9b53b61 Reword content articles to use "tokens"
This replaces the old wording of "issued currencies" and introduces
broader usage of the term "stablecoins" to more closely match the
terminology in use by the wider industry.

I've also added a draft "Common Misunderstandings about Freezes" page so
that the Freeze page doesn't have to protest quite so much, and written
a very brief word on tokens' use for community credit.

This commit only covers the Concepts section, in English, and likely
leaves some links to the old URLs for the renamed pages.
2022-02-11 18:01:40 -08:00
mDuo13
8abb3e6348 Fix a bunch of broken links 2022-02-09 16:45:53 -08:00
Rome Reginelli
fd39520c93 Merge pull request #1279 from develoQ/translate-to-japanese
Translate to Japanese
2022-01-10 23:47:25 -08:00
mDuo13
a07bfb20a0 [JA] fix syntax errors 2022-01-10 23:46:40 -08:00