Commit Graph

606 Commits

Author SHA1 Message Date
tequ
d73dae201e remove-hi 2023-09-27 02:40:28 +09:00
tequ
4e773b9c32 Add script for message generation
- set TZ to UTC(+0)
2023-09-12 13:31:24 +09:00
mDuo13
8283078e17 Restore Python 3.5 compatibility
Our (current, deprecated) build process relies on Python 3.5, so this
removes incompatible (f-strings) syntax from the "enforce_filenames"
filter.
2023-09-11 16:45:22 -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
akcodez
f966a6e8c1 rm print 2023-04-26 09:32:52 -07:00
akcodez
f8a4fa435a adds more filters, adds bg images for cards 2023-04-26 09:29:01 -07:00
akcodez
4dfc7104d8 adds new logic to categorize dates function to help with filters 2023-04-24 12:41:17 -07:00
akcodez
3be3f0a29d adds tool and filter to ddactyl-config adds logic to events page 2023-03-24 09:49:30 -07: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
oeggert
a271942c1e Merge pull request #1598 from XRPLF/oeggert/issue1554
Add code samples for markers and pagination.
2022-11-29 14:23:58 -08:00
mDuo13
bc752f213d Enable include_code by default 2022-11-22 16:18:30 -08:00
mDuo13
afc0d8ae8d Fix tool/build_all_langs.sh continuing after failure 2022-11-22 16:09:20 -08:00
mDuo13
b62b81ac1f Code samples: sort intro things first 2022-05-13 13:35:04 -07:00
Jake
1eae37e095 Add filter for code lang 2022-04-20 14:06:22 -07:00
mDuo13
7c3ff821f0 Code samples: READMEs and smarter parsing 2022-04-20 14:04:04 -07:00
mDuo13
acb0698940 Code samples: parse READMEs better and use smarter default titles 2022-04-20 14:04:04 -07:00
mDuo13
cf48dcbd38 First draft code samples page 2022-04-20 14:04:04 -07:00
mDuo13
ec25f6bbdd Merge branch 'wallet_tutorial' 2022-02-08 15:13:12 -08:00
mDuo13
4dba0cf70f Build a Wallet: progress thru step 3:
- Tutorial docs through step 3 (inputting an account)
- New screenshots
- Minor code cleanup
- Fix the include_code filter to better handle indentation in Python
  code
2022-01-19 17:33:23 -08:00
Ferschmann Jakub
0aa0397e7d Show answer by url hash fragment
Show the answer of the question if there is a hash fragment in the url. Suitable when sending url with id of question.  Until now, the answer has not been shown.
2021-11-15 12:21:12 +01:00
Rome Reginelli
fdade7a555 Merge pull request #1228 from jakeatdocforce/fix-1141
Filter () and : in code tabs
2021-11-09 15:05:51 -08:00
Jake
964b1cf7f9 Filter () and : in code tabs 2021-11-07 16:15:56 -07:00
mDuo13
473f38329d Freeze/interactive tutorials: edits per reviews 2021-10-26 14:43:10 -07:00
mDuo13
d5f10b1d68 Interactive tutorials readme: update samples to xrpl.js 2.0 2021-10-20 12:52:11 -07:00
mDuo13
aa08c82c57 Copy to clipboard: remove temp bits 2021-09-21 15:59:46 -07:00
Jake
312ac60a5c Add code buttons to btngroup
Expand button added to btn group with copy button.
Placed btn top right of box.
2021-09-21 14:37:38 -07:00
Jake
ab4fa73ff1 Adjust copy button
Change to clipboard icon.
Position right and top of code blocks.
2021-09-21 14:37:38 -07:00
Jake
99c698a215 First pass copy to clipboard 2021-09-21 14:37:38 -07:00
mDuo13
c0ab56ea62 Interactive tutorials: number steps for analytics
Count the total number of interactive blocks and add this data to the
memo when sending transactions from interactive tutorials. This should
help track the completion rate of tutorials to better measure
effectiveness of the documentation.
2021-09-07 19:35:32 -07:00
mDuo13
c63a2251a8 Fix spelling and link errors 2021-08-18 18:16:31 -07:00
mDuo13
9112945fe2 Issue token tutorial: use memos, wait steps" 2021-08-18 16:58:17 -07:00
mDuo13
369c678013 Update repo URL to XRPLF 2021-07-23 02:05:37 -07:00
mDuo13
47c3aa6f07 Merge branch 'master' into light-mode-theme 2021-07-19 14:02:25 -07:00
Rome Reginelli
80fc15a834 Merge pull request #1118 from ripple/faq_template
De-duplicate FAQs
2021-07-19 13:39:16 -07:00
mDuo13
be80405f10 Fix light mode, top nav external links, etc:
- Top nav external links now open in a new tab as intended (not specific
  to light mode)
- Consistently adjust opacity (not placement) of background images in
  mobile; lighter in light mode for legibility.
- Add a subtle white "shadow" to eyebrow text in light mode to improve
  legibility
- Fix focus styles for buttons & multicode tabs in light mode
- Make all buttons sized the same as primary buttons by default
- Fix typo that caused the "Reset" button on get-started to be unstyled
- Refactor theme switcher JS for simplicity.
- Fix issue with theme select icon not being visible in some cases.
- Update color of  icons in interactive tutorial breadcrumbs
2021-07-14 15:52:27 -07:00
Rome Reginelli
00a8bfd4da Merge pull request #1098 from jakeatdocforce/codesample-tabs
Code tabs - switch all tabs and remember setting
2021-07-07 13:30:16 -07:00
mDuo13
abe7942a27 De-duplicate FAQs 2021-07-06 23:42:05 -07:00
mDuo13
87fe5462ed FAQ filter: Start on making text expandable 2021-07-06 23:41:50 -07:00
mDuo13
b886f6ceaf Start replacing FAQ with MD filter 2021-07-06 23:41:30 -07:00
Jake
7dca2c5852 Strip commas out of tab names 2021-06-17 14:49:19 -07:00
mDuo13
3e110f3852 Move/rename templates 2021-06-15 12:01:08 -07:00
mDuo13
b5f8ed4efc Merge branch 'master' into 2021_refresh 2021-06-14 16:35:29 -07:00
mDuo13
578435cd0a Labels: finish tagging content, add final styles 2021-06-14 14:49:10 -07:00
jakeatdocforce
a822e5ee52 Merge branch 'ripple:master' into codesample-tabs 2021-06-11 09:37:05 -07:00
mDuo13
68ea8dea66 Remove XRPL Grants banner (application period has ended) 2021-06-09 22:41:28 -07:00
mDuo13
f06e1ad447 Colored styling for labels 2021-06-07 15:36:36 -07:00
mDuo13
7b44ea177b Label browsing: more labels, style updates, etc. 2021-06-04 14:31:42 -07:00
mDuo13
366ff1d2d0 Label Browsing: better views, tag cloud, more tags 2021-06-03 18:50:30 -07:00
mDuo13
d48c3d57a1 Label browsing: proof of concept 2021-06-02 18:17:16 -07:00
Jake
6eeb0d58f5 Add save lang to code tabs.
WIP.
If multiple tab blocks have different names it will hide all.
2021-06-01 14:09:41 -07:00