Commit Graph

67 Commits

Author SHA1 Message Date
mDuo13
838225f798 Add line breaks after initial h1's consistently 2023-10-16 16:30:34 -07: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
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
0f9c02ce5a [JA] update concepts/accounts 2023-09-27 01:26:11 +09:00
tequ
945cf804a1 [JA] fix XRPレジャー to XRP Ledger 2023-09-25 12:51:52 +09:00
Dennis Dawson
adf8617de0 Merge pull request #2129 from XRPLF/uc-images
Add uc pics
2023-09-19 11:30:47 -07:00
ddawson
5671595a97 changes per review 2023-09-15 09:52:09 -07:00
ddawson
a1b6282d9a Add uc pics 2023-09-13 11:16:41 -07:00
tequ
72e82a449b [JA] update concepts, use-cases in IA.v3 2023-09-12 18:19:38 +09:00
ddawson
8aa25dfca4 fix links 2023-09-05 15:24:36 -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
b1339f84c6 Clean up unused / removed pages & images
- Delete folders for new pages that are handled by templates w/ no
  markdown source
- Fully remove "Use Cases", leaving redirects for deleted pages.
    - Move certain pages to new areas & remove Use Case markup
- Add "Contribute Code to the XRP Ledger" draft page
- Fix image paths in some Japanese-translated pages
2020-09-18 16:39:52 -07:00
mDuo13
c63d10d116 Most spelling, more style cleanup 2020-07-24 03:28:02 -07:00
mDuo13
1101d65051 Start applying spell-checking 2020-07-24 03:25:59 -07:00
mDuo13
7b188351c0 CRLF to LF; fix some broken links 2019-11-05 23:09:32 -08:00
mDuo13
430e4f4515 Japanese translation: add remaining files 2019-11-05 23:08:41 -08:00
mDuo13
8ab0611462 Link fixes and other cleanup
- Clarifies that SetFee transaction hashes weren't always unique
  (Fixes #696)
- Fixes some broken links and adds a couple more useful links.
- Mention different types of transactions in tx basics page
- Fix inconsistent naming of 'list xrp...' use case
2019-10-16 14:39:10 -07:00
Jake Bonham
a26a8eeeae Use case steps and links
Adjusted numbering
added external link wrappers
added wrapper for related lists
moved link from headline to button below
2019-06-13 12:07:02 -07:00
mDuo13
ca0799c043 List XRP use case: use buttons instead of header links 2019-06-13 12:07:01 -07:00
Jennifer Hasegawa
b921782259 paychan use case: rome's feedback 2019-03-21 13:38:16 -07:00
Jennifer Hasegawa
924af1ff79 paychan use case: rome's feedback 2019-03-20 16:43:00 -07:00
Jennifer Hasegawa
89cdf64d1c paychan use case: rome's feedback 2019-03-18 14:52:16 -07:00
Jennifer Hasegawa
4505a6a6e1 paychan use case: why move xrp 2019-03-15 16:52:01 -07:00
Jennifer Hasegawa
411a1fb75b paychan use case: rome's feedback 2019-03-13 17:16:07 -07:00
Jennifer Hasegawa
8bf9d32620 PayChan Use Case: Rome's feedback 2019-03-13 13:13:46 -07:00
Jennifer Hasegawa
f3bfa40f4f addressing feedback 2019-03-13 13:13:46 -07:00
Jennifer Hasegawa
c3095fd271 page name and link fixes 2019-03-13 13:13:46 -07:00
Jennifer Hasegawa
358b68b391 refined per PM review 2019-03-13 13:13:46 -07:00
Jennifer Hasegawa
ff2cb2b393 first draft out 2019-03-13 13:13:46 -07:00
Jennifer Hasegawa
ecaa8a0fc5 still working 2019-03-13 13:13:45 -07:00
Jennifer Hasegawa
66ebdf5d23 refined 2019-03-13 13:13:45 -07:00
Jennifer Hasegawa
a87b4c1019 first draft 2019-03-13 13:13:45 -07:00
Jennifer Hasegawa
4f28ea49dd Merge pull request #523 from jhaaaa/validator-connects
Update validator tutorial to address public hub connections
2019-03-06 09:25:42 -08:00
Jennifer Hasegawa
b1fdce6d0b esrow use case: rome's feedback 2019-03-05 10:15:56 -08:00
Jennifer Hasegawa
a9f8f9dfe9 escrow use case: Rome's feedback 2019-03-04 17:54:09 -08:00
Jennifer Hasegawa
77dabba09d escrow use case: template updates 2019-02-27 17:34:12 -08:00
Jennifer Hasegawa
7c8a7bf028 escrow use case: copyedits 2019-02-27 17:17:16 -08:00
Jennifer Hasegawa
af3a15b564 escrow use case: rome's feedback 2019-02-27 17:17:16 -08:00
Jennifer Hasegawa
878cdd28ca first draft 2019-02-27 17:17:16 -08:00
Jennifer Hasegawa
a82e3805d7 still working 2019-02-27 17:17:16 -08:00
Jennifer Hasegawa
81df8f37d4 still working 2019-02-27 17:17:16 -08:00
Jennifer Hasegawa
44138a4054 wip - need to test flow 2019-02-27 17:17:16 -08:00
Jennifer Hasegawa
a755a7ac51 smart contract use case 2019-02-27 17:17:15 -08:00
Jennifer Hasegawa
75fd2bbccd validator tut: daniel, rome feedback 2019-02-27 17:05:03 -08:00
mDuo13
b18747f658 Updated use case template 2019-02-26 17:58:40 -08:00
Jennifer Hasegawa
2a0990495f validator tut: public hubs 2019-02-25 17:24:03 -08:00
mDuo13
5cd99d2fb9 Contribute to rippled: fix link from external link change 2019-02-07 15:26:46 -08:00
mDuo13
9f2eff14f2 Migrate external links to md syntax 2019-02-07 13:37:57 -08:00
Jennifer Hasegawa
115057b280 improve validator doc
first draft improvements

inc'd feedback from Rome and Daniel

fixed format, links

validator in cluster ok

inc'd feedback

few last edits
2019-01-10 11:24:38 -08:00