Commit Graph

144 Commits

Author SHA1 Message Date
Rome Reginelli
64aad0b2e7 Merge pull request #2215 from XRPLF/place_indexes
Add index md files
2023-10-18 13:44:23 -07:00
Rome Reginelli
ad9ca2e74b Merge pull request #2216 from ximinez/vl_fix
Update validator list method example
2023-10-16 16:55:40 -07:00
mDuo13
5ec8f96a67 Merge branch 'clio_server_info_libxrpl_version' 2023-10-16 16:37:00 -07:00
mDuo13
129ffbe46e Clio server_info: fix broken link 2023-10-16 16:35:21 -07:00
mDuo13
838225f798 Add line breaks after initial h1's consistently 2023-10-16 16:30:34 -07:00
Rome Reginelli
c58cfe23ed Merge pull request #2154 from godexsoft/clio_unsupported_subscription
Unsupported streams in Clio
2023-10-16 14:56:42 -07:00
Rome Reginelli
85818a47d2 Merge pull request #2147 from godexsoft/clio_ledger_accounts_not_supported
Document unsupported fields in ledger command
2023-10-16 14:56:10 -07:00
Rome Reginelli
bcd4be5aa4 Merge pull request #2138 from godexsoft/account_tx-tx_type
Add tx_type to request fields
2023-10-16 14:55:36 -07:00
Ed Hennis
72d054d643 Update validator list method example
* Add required public key to the HTTP request URL.
* Add "public_key" field to result JSON.
2023-10-16 16:24:39 -04:00
mDuo13
e5405d8946 Add/update some blurbs for index pages 2023-10-13 17:01:04 -07:00
mDuo13
70c3c8a1fa Add md files for auto index pages
Part of IA and Redocly migration work. Create simple .md files to
represent the automatic index pages that previously only existed in
the dactyl-config.yml file. (The code used to do this is also part
of the commit but is, hopefully, no longer needed.)
2023-10-12 17:07:04 -07:00
Rome Reginelli
35f267bd99 Merge pull request #2206 from XRPLF/migrate_ja
[JA] Move files to a dir compatible with Redocly
2023-10-10 14:17:02 -07:00
Amarantha Kulkarni
7f5c95c501 Merge pull request #2183 from ximinez/XRPFees_fee_ref
Note that `fee_ref` will be removed if XRPFees is enabled
2023-10-10 12:56:39 -07:00
Elliot Lee
2e1d5d32cc Update content/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md
Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>
2023-10-09 23:20:34 -07:00
mDuo13
26b3939747 [JA] Move files to a dir compatible with Redocly
The new folder will be compatible with both Dactyl and Redocly when it
comes to loading the Japanese translation for a given page.

Snippets are not moved for now because importing them would require
more complex changes to the actual Markdown pages, and wouldn't be
cross-compatible anyway (Redocly uses slightly different 'partial'
rather than 'include' syntax.)
2023-10-09 11:33:55 -07:00
tequ
c02ebc69c7 [JA] update AMM pages
- [JA] Add DisallowIncoming AccountRoot page
2023-10-05 15:29:45 +09:00
Ed Hennis
34a3d23cbc Take @intelliot's suggestion to reword.
Co-authored-by: Elliot Lee <github.public@intelliot.com>
2023-10-03 17:22:06 -04:00
Ed Hennis
d9f1141266 Note that fee_ref will be removed if XRPFees is enabled 2023-10-03 14:07:25 -04:00
tequ
12eb0a81d3 [JA] update concepts/ledgers 2023-09-26 21:27:12 +09:00
Rome Reginelli
27ef3b5a4a Merge pull request #2161 from develoQ/ja-xrp-ledger
[JA] Fix `XRPレジャー` to `XRP Ledger`
2023-09-25 10:33:23 -07:00
Elliot Lee
12a51b0769 account_info - describe current behavior of rippled
At time of writing, `rippled` stable only supports api_version 1, where the `signer_lists` is returned nested under `account_data`.
2023-09-25 08:52:47 -07:00
tequ
945cf804a1 [JA] fix XRPレジャー to XRP Ledger 2023-09-25 12:51:52 +09:00
Alex Kremer
2cb52758e4 Add note about Clio 2023-09-22 13:59:33 +01:00
Alex Kremer
b1a3e24652 Update with forwarding in mind 2023-09-22 13:40:58 +01:00
Alex Kremer
4426e04afd Move outdated_translation to config 2023-09-21 20:13:55 +01:00
Alex Kremer
14c59007b7 Refresh example requests and responses 2023-09-21 01:18:03 +01:00
Alex Kremer
77e49d30cc Update content/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md
Co-authored-by: Rome Reginelli <mduo13@gmail.com>
2023-09-21 00:49:08 +01:00
Alex Kremer
d4fb95e2b7 Fix review issues 2023-09-21 00:45:12 +01:00
Alex Kremer
86c59cb224 Update content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md
Co-authored-by: Rome Reginelli <mduo13@gmail.com>
2023-09-21 00:35:51 +01:00
Alex Kremer
9f68c39203 Update content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md
Co-authored-by: Rome Reginelli <mduo13@gmail.com>
2023-09-21 00:34:31 +01:00
Alex Kremer
896d10b510 Add missing fields to server_info doc 2023-09-20 01:09:15 +01:00
Alex Kremer
90ed92c52c Document unsupported fields in ledger command 2023-09-20 00:41:13 +01:00
Alex Kremer
92d2ab7c32 Apply suggestion by Elliot
Co-authored-by: Elliot Lee <github.public@intelliot.com>
2023-09-19 20:04:56 +01:00
Alex Kremer
72b0460be4 Add tx_type to request fields 2023-09-19 17:00:03 +01:00
mDuo13
f130a7bc60 Update rippled repo URL
Fix #2070.
2023-09-15 15:21:58 -07:00
mDuo13
078814af62 server_info/state: Clean up load cost wordings & links 2023-09-14 15:29:55 -07:00
mDuo13
2ec0b0489d server_info/state: document new ports field 2023-09-13 16:36:45 -07:00
mDuo13
7790cbc01b Fix build errors 2023-09-07 04:24:15 -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
tequ
08048d1323 [JA] fix topnav, sidenav 2023-09-02 10:00:49 +09: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
tequ
2df5ccf827 [JA] Follow-up of #2073 2023-08-23 11:51:42 +09:00
Rome Reginelli
1b656494a2 Merge pull request #2057 from develoQ/ja-ledger-entry
[JA] translate ledger_entry
2023-08-22 17:56:58 -07:00
Rome Reginelli
b357203e27 Merge pull request #2010 from XRPLF/stand-alone-vs-initial-ledger
commandline-usage: separate stand-alone + initial ledger options
2023-08-11 14:44:23 -07:00
mDuo13
61aeaccfd3 Change 'test networks' to just 'networks' to acknowledge sidechains 2023-08-08 14:45:17 -07:00
mDuo13
10bb54e4f1 Clarify/update initial ledger options 2023-08-08 14:44:08 -07:00
tequ
ada84e6a48 [JA] translate account_nfts 2023-08-08 17:51:27 +09:00
tequ
4661a861ed [JA] update ledger_entry 2023-08-08 17:07:37 +09:00
Peter Chen
805a02f38f change "limit" description to include "positive" 2023-08-01 13:42:43 -04:00