Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Symbol Documentation

[![Build Status](https://jenkins.symboldev.com/job/Symbol/job/Docs/job/symbol-docs/job/main/badge/icon)](https://jenkins.symboldev.com/job/Symbol/job/Docs/job/symbol-docs/job/main/)
[![Build Status](https://jenkins.symbolsyndicate.us/job/Symbol/job/Docs/job/symbol-docs/job/main/badge/icon)](https://jenkins.symbolsyndicate.us/job/Symbol/job/Docs/job/symbol-docs/job/main/)

Browse the documentation to start integrating blockchain technology into your project.

Expand Down Expand Up @@ -48,7 +48,7 @@ Surf Symbol's reference documentation to learn more about our APIs, SDKs, CLIs,
Symbol is an [open-source](https://github.com/symbol) project.
Discover how our [community](https://github.com/symbol/community/) is organized, and get started participating:

* Reach our community joining the official [Discord](https://discord.com/invite/xymcity).
* Reach our community joining the official [Discord](https://discord.gg/J38KwW5ZuG).
* Check the [contributing guidelines](https://docs.symbol.dev/guidelines/suggesting-changes.html) to propose changes.
* Follow the development updates on Twitter.
* [Symbol Official account](https://twitter.com/thesymbolchain)
Expand Down
6 changes: 3 additions & 3 deletions source/_static/retired/qr-library/0.14.3/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ <h1>Symbol QR Library</h1>
</a>
<p><a href="https://badge.fury.io/js/symbol-qr-library"><img src="https://badge.fury.io/js/symbol-qr-library.svg" alt="npm version"></a>
<a href="https://travis-ci.com/symbol/symbol-qr-library.svg?branch=main"><img src="https://travis-ci.com/symbol/symbol-qr-library.svg?branch=main" alt="Build Status"></a>
<a href="https://discord.com/invite/xymcity"><img src="https://img.shields.io/badge/chat-on%20discord-green.svg" alt="Discord"></a></p>
<a href="https://discord.gg/J38KwW5ZuG"><img src="https://img.shields.io/badge/chat-on%20discord-green.svg" alt="Discord"></a></p>
<p>Library to generate QR codes for Symbol.</p>
<p><strong>NOTE</strong>: The author of this package cannot be held responsible for any loss of money or any malintentioned usage forms of this package. Please use this package with caution.</p>

Expand Down Expand Up @@ -82,7 +82,7 @@ <h2>Getting help</h2>
<p>Use the following available resources to get help:</p>
<ul>
<li><a href="https://docs.symbolplatform.com/">Symbol Documentation</a></li>
<li>Join the community <a href="https://discord.com/invite/xymcity">discord</a> </li>
<li>Join the community <a href="https://discord.gg/J38KwW5ZuG">discord</a> </li>
<li>If you found a bug, <a href="https://github.com/symbol/symbol-qr-library/issues">open a new issue</a></li>
</ul>

Expand All @@ -97,4 +97,4 @@ <h2>License</h2>
</a>
<p>(C) Symbol Contributors 2022</p>
<p>Licensed under the <a href="LICENSE">Apache License 2.0</a></p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/AccountQR.html">AccountQR</a></li><li class=" tsd-kind-module"><a href="modules/AddressQR.html">AddressQR</a></li><li class=" tsd-kind-module"><a href="modules/ContactQR.html">ContactQR</a></li><li class=" tsd-kind-module"><a href="modules/CosignatureQR.html">CosignatureQR</a></li><li class=" tsd-kind-module"><a href="modules/CosignatureSignedTransactionQR.html">Cosignature<wbr/>Signed<wbr/>TransactionQR</a></li><li class=" tsd-kind-module"><a href="modules/EncryptedPayload.html">Encrypted<wbr/>Payload</a></li><li class=" tsd-kind-module"><a href="modules/MnemonicQR.html">MnemonicQR</a></li><li class=" tsd-kind-module"><a href="modules/ObjectQR.html">ObjectQR</a></li><li class=" tsd-kind-module"><a href="modules/QRCode.html">QRCode</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeDataSchema.html">QRCode<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeGenerator.html">QRCode<wbr/>Generator</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeInterface.html">QRCode<wbr/>Interface</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeSettings.html">QRCode<wbr/>Settings</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeStreamType.html">QRCode<wbr/>Stream<wbr/>Type</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeType.html">QRCode<wbr/>Type</a></li><li class=" tsd-kind-module"><a href="modules/SignedTransactionQR.html">Signed<wbr/>TransactionQR</a></li><li class=" tsd-kind-module"><a href="modules/TransactionQR.html">TransactionQR</a></li><li class=" tsd-kind-module"><a href="modules/schemas_AddContactDataSchema.html">schemas/<wbr/>Add<wbr/>Contact<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_CosignatureSignedTransactionDataSchema.html">schemas/<wbr/>Cosignature<wbr/>Signed<wbr/>Transaction<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportAccountDataSchema.html">schemas/<wbr/>Export<wbr/>Account<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportAddressDataSchema.html">schemas/<wbr/>Export<wbr/>Address<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportMnemonicDataSchema.html">schemas/<wbr/>Export<wbr/>Mnemonic<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportObjectDataSchema.html">schemas/<wbr/>Export<wbr/>Object<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_RequestCosignatureDataSchema.html">schemas/<wbr/>Request<wbr/>Cosignature<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_RequestTransactionDataSchema.html">schemas/<wbr/>Request<wbr/>Transaction<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_SignedTransactionDataSchema.html">schemas/<wbr/>Signed<wbr/>Transaction<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/sdk.html">sdk</a></li><li class=" tsd-kind-module"><a href="modules/sdk_INetworkType.html">sdk/INetwork<wbr/>Type</a></li><li class=" tsd-kind-module"><a href="modules/sdk_ISignedTransaction.html">sdk/ISigned<wbr/>Transaction</a></li><li class=" tsd-kind-module"><a href="modules/sdk_ITransaction.html">sdk/ITransaction</a></li><li class=" tsd-kind-module"><a href="modules/services_EncryptionService.html">services/<wbr/>Encryption<wbr/>Service</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/AccountQR.html">AccountQR</a></li><li class=" tsd-kind-module"><a href="modules/AddressQR.html">AddressQR</a></li><li class=" tsd-kind-module"><a href="modules/ContactQR.html">ContactQR</a></li><li class=" tsd-kind-module"><a href="modules/CosignatureQR.html">CosignatureQR</a></li><li class=" tsd-kind-module"><a href="modules/CosignatureSignedTransactionQR.html">Cosignature<wbr/>Signed<wbr/>TransactionQR</a></li><li class=" tsd-kind-module"><a href="modules/EncryptedPayload.html">Encrypted<wbr/>Payload</a></li><li class=" tsd-kind-module"><a href="modules/MnemonicQR.html">MnemonicQR</a></li><li class=" tsd-kind-module"><a href="modules/ObjectQR.html">ObjectQR</a></li><li class=" tsd-kind-module"><a href="modules/QRCode.html">QRCode</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeDataSchema.html">QRCode<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeGenerator.html">QRCode<wbr/>Generator</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeInterface.html">QRCode<wbr/>Interface</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeSettings.html">QRCode<wbr/>Settings</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeStreamType.html">QRCode<wbr/>Stream<wbr/>Type</a></li><li class=" tsd-kind-module"><a href="modules/QRCodeType.html">QRCode<wbr/>Type</a></li><li class=" tsd-kind-module"><a href="modules/SignedTransactionQR.html">Signed<wbr/>TransactionQR</a></li><li class=" tsd-kind-module"><a href="modules/TransactionQR.html">TransactionQR</a></li><li class=" tsd-kind-module"><a href="modules/schemas_AddContactDataSchema.html">schemas/<wbr/>Add<wbr/>Contact<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_CosignatureSignedTransactionDataSchema.html">schemas/<wbr/>Cosignature<wbr/>Signed<wbr/>Transaction<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportAccountDataSchema.html">schemas/<wbr/>Export<wbr/>Account<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportAddressDataSchema.html">schemas/<wbr/>Export<wbr/>Address<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportMnemonicDataSchema.html">schemas/<wbr/>Export<wbr/>Mnemonic<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_ExportObjectDataSchema.html">schemas/<wbr/>Export<wbr/>Object<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_RequestCosignatureDataSchema.html">schemas/<wbr/>Request<wbr/>Cosignature<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_RequestTransactionDataSchema.html">schemas/<wbr/>Request<wbr/>Transaction<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/schemas_SignedTransactionDataSchema.html">schemas/<wbr/>Signed<wbr/>Transaction<wbr/>Data<wbr/>Schema</a></li><li class=" tsd-kind-module"><a href="modules/sdk.html">sdk</a></li><li class=" tsd-kind-module"><a href="modules/sdk_INetworkType.html">sdk/INetwork<wbr/>Type</a></li><li class=" tsd-kind-module"><a href="modules/sdk_ISignedTransaction.html">sdk/ISigned<wbr/>Transaction</a></li><li class=" tsd-kind-module"><a href="modules/sdk_ITransaction.html">sdk/ITransaction</a></li><li class=" tsd-kind-module"><a href="modules/services_EncryptionService.html">services/<wbr/>Encryption<wbr/>Service</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
2 changes: 1 addition & 1 deletion source/_templates/include/social.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<img alt="Twitter" src="{{ pathto('_static/images/Badge-Twitter.png', 1) }}" width="51" height="48"></a>
</li>
<li>
<a href="https://discord.com/invite/xymcity" rel="nofollow" title="Discord">
<a href="https://discord.gg/J38KwW5ZuG" rel="nofollow" title="Discord">
<img alt="Discord" src="{{ pathto('_static/images/Badge-Discord.png', 1) }}" width="51" height="48"></a>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ def setup(app):
.. |desktop-wallet| replace:: Symbol Desktop Wallet
.. |discord| raw:: html

<a href="https://discord.com/invite/xymcity" target="_blank">Discord</a>
<a href="https://discord.gg/J38KwW5ZuG" target="_blank">Discord</a>

.. |nem| raw:: html

Expand Down
6 changes: 3 additions & 3 deletions source/guidelines/translating-the-documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ If you are planning on helping, make sure to join the |discord| server and enter
Getting started for translators
*******************************

1. Create a new Transifex account `here <https://www.transifex.com/signup/?join_project=symboldocs>`_.
1. Create a new Transifex account `here <https://app.transifex.com/signup/?join_project=symboldocs>`_.

2. Join the `symbol-docs team <https://www.transifex.com/nemtech/symboldocs/>`_. Click on **Help Translate "symbol-docs"** button on the right side of the header, selecting the language you want to contribute.
2. Join the `symbol-docs team <https://app.transifex.com/nemtech/symboldocs/>`_. Click on **Help Translate "symbol-docs"** button on the right side of the header, selecting the language you want to contribute.

3. Wait until the translation coordinator approves your request. Once accepted you will receive an email. At this moment, you will be able to start translating the docs.

Expand Down Expand Up @@ -126,4 +126,4 @@ Follow these instructions to publish updated source literals to Transifex.

.. |bt| raw:: html

<code class="code docutils literal notranslate">`</code>
<code class="code docutils literal notranslate">`</code>
4 changes: 2 additions & 2 deletions source/guides/account/how-to-use-ledger-hardware-wallet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,6 @@ Contact Support

For technical support, you may reach us at:

- Discord: https://discord.com/invite/xymcity
- Discord: https://discord.gg/J38KwW5ZuG

- Telegram: @nemhelpdesk
- Telegram: @nemhelpdesk
4 changes: 0 additions & 4 deletions source/guides/migration/post-optin-xym-retrieval.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,6 @@ This is a short list of items to check should you encounter any problem when rec

- Check that you are using the **correct Symbol mnemonic**. Did you do several attempts at opting-in and obtained different mnemonics?

- Check that your NIS1 account was successfully opted-in by looking up its address in the `opt-in Report <http://report.experimental.symboldev.network/ok1.html>`__.

If your account is not on the list, check the other tabs to find the reason.

- The **NEM Helpdesk** can help you if everything else fails:

- `NEM's Telegram Help Desk <https://t.me/nemhelpdesk>`__
Expand Down
6 changes: 3 additions & 3 deletions source/handbook/doc-repos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Technical documentation
**Intended readers** ; The world at large.
**Intended writers** ; The Symbol technical writers.
**Editing workflow** ; Git-based: Check out the source repository, make modifications, check results by building the pages locally and submit pull requests.
**Localization** ; `Transifex <https://www.transifex.com/nemtech/symboldocs/>`__
**Localization** ; `Transifex <https://app.transifex.com/nemtech/symboldocs/>`__
**Maintainers** ; `Xavi <https://github.com/segfaultxavi>`__

Content
Expand Down Expand Up @@ -71,7 +71,7 @@ This generates all HTML files in the ``build/html`` folder, including all assets
Deployment
----------

The GitHub repository is linked to `Jenkins <https://jenkins.symboldev.com/job/Symbol/job/Docs/job/symbol-docs>`__, so on every push to the
The GitHub repository is linked to `Jenkins <https://jenkins.symbolsyndicate.us/job/Symbol/job/Docs/job/symbol-docs>`__, so on every push to the
``main`` branch a full build is triggered (See ``Jenkinsfile``). This involves several steps besides
the generation of the output documentation:

Expand All @@ -91,7 +91,7 @@ Localization

Right now almost every page is available in Japanese besides the original English, but the repository is ready to accept more languages.

`Transifex <https://www.transifex.com/nemtech/symboldocs/>`__ is integrated in the deployment process, so after every push to ``main`` Travis extracts and sends all strings (``.pot`` files) to Transifex, which detects any new or updated text and notifies the translators.
`Transifex <https://app.transifex.com/nemtech/symboldocs/>`__ is integrated in the deployment process, so after every push to ``main`` Travis extracts and sends all strings (``.pot`` files) to Transifex, which detects any new or updated text and notifies the translators.

Translators can log in to Transifex and provide the translations there. Developers can then download the updated text (``.po`` files) and commit them to the source repository.

Expand Down