New documentation - #826
Draft
segfaultxavi wants to merge 74 commits into
Draft
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #826 +/- ##
=========================================
Coverage 93.57% 93.57%
Complexity 6078 6078
=========================================
Files 719 719
Lines 17372 17372
Branches 1313 1313
=========================================
Hits 16255 16255
Misses 864 864
Partials 253 253
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Doxygen creates some methods called [static initializer], but the mkdocs wrapper does not expect method names to begin with a [. This patch includes the open bracket as a valid first letter for a method.
* [mkdocs] docs: add transactions concept [mkdocs] docs: review transactions concept [mkdocs] docs: review transactions concept [mkdocs] docs: review transactions concept * [mkdocs] docs: apply comments
* [mkdocs] docs: add transfer transctions concept [mkdocs] docs: review transfer tx concept [mkdocs] docs: review transfer tx concept [mkdocs] docs: review transfer tx concept [mkdocs] docs: review transfer tx concept * [mkdocs] docs: apply comments
Otherwise, we get deprecation warnings.
* [mkdocs] docs: add namespace concept * [mkdocs] docs: apply comments * [mkdocs] docs: apply comments
* [mkdocs] docs: add blocks concept * [mkdocs] docs: update sidebar
* [mkdocs] docs: add mosaics concept * [mkdocs] docs: apply comments
* [mkdocs] docs: add consensus and harvesting concepts * [mkdocs] docs: review harvesting * [mkdocs] docs: review harvesting * [mkdocs] add: reviewer feedback --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adds the Getting Started section to the developer manual, ported and adapted from the Symbol docs. It also brings the latest docs script updates: - Sync lint and build tooling from Symbol. - Configured scripts to generate Python and TS references - Moves OpenAPI from Swagger to Scalar - Exclude Java reference from being generated (it's not a Java SDK but NIS) --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [faucet tutorial](https://docs.symboltest.net/en/devbook/accounts/testnet-faucet/) to NEM.
Adapts [Query account balance](https://docs.symboltest.net/en/devbook/accounts/query-balance/) tutorial to NEM. Related improvement for Symbol: symbol/symbol#2014 --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts the [transfer transaction](https://docs.symboltest.net/en/devbook/transactions/transfer/) tutorial to NEM. Note: We'll have a separate one for transferring mosaics.
Removed the papirus bg and used darker link colors in light mode for better readability.
Depends on #921 Added some CSS rules to the API reference so it uses the same font family and font size as the rest of the documentation. It also sets the dark mode background color to match the site's background color. If looks ok, I'll apply it to Symbol docs.
Adapts [send messages](https://docs.symboltest.net/en/devbook/transactions/messages/) tutorial to NEM.
Install deps required for websocket tutorials so eslint can find them.
Adapts [Register root namespace](https://docs.symboltest.net/en/devbook/namespaces/register-root-namespace/) and [Extend root namespace](https://docs.symboltest.net/en/devbook/namespaces/extend-root-namespace/) to NEM.
Address review comments from @Jaguar0625 on July 2.
Adapts [Register subnamespace](https://docs.symboltest.net/en/devbook/namespaces/register-subnamespace/) guide to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [Create mosaic](https://docs.symboltest.net/en/devbook/mosaics/create-mosaic/) and [Change mosaics supply](https://docs.symboltest.net/en/devbook/mosaics/change-mosaic-supply/) tutorials to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [Modify mosaic definition](https://docs.symboltest.net/en/devbook/mosaics/modify-mosaic-definition/) to NEM.
Adds a mix of improvements reported in Discord and others discovered while porting some changes to Symbol. See the PR comments for specific details.
Address review comments from @Jaguar0625 on July 16.
Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Right now there is only one link to the whiepaper, buried in the Accounts textbook page. This commit adds the whitepaper to the Reference section, since it is the ultimate reference.
GLightbox, the plugin to show images with zoom capabilities, is not styling the text in the image captions when the image is zoomed-in. This patch fixes the `code` and link colors.
Our image template was incorrect in using `.data-description` attribute instead of `data-description`. Previous version of the glightbox plugin accepted it because they used a lenient regex, but the latest version uses proper HTML parsing and ignores our incorrect attribute. As a result, zommed-in images did not have a caption, which is where we write the user guide steps. Fixed by removing the extra dot from the attribute.
Previously it produced an endless redirection loop because the redirection URL was relative.
So they look like block snippets.
Previous one worked well enough for the examples, but was not complete. This one has been generated from the Lark grammar.
Adapts [configure multisig tutorial](https://docs.symboltest.net/en/devbook/accounts/configure-multisig/) to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [sign multisig tutorial](https://docs.symboltest.net/en/devbook/transactions/sign-multisig/) to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adds Listening to Multisig Transaction Flow tutorial. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
## Problem The query-currency-supply tutorial converts each non-circulating account balance from microXEM to whole XEM using floating-point division. It then adds those values and subtracts the result from the total supply. Because the balances are large, for example, the treasury holds about 1.4 × 10¹⁵ microXEM, floating-point rounding can affect the converted values. Subtracting two nearly equal numbers can amplify that rounding error and change the final decimal digit of the displayed circulating supply. ## Solution Keep all balances in atomic units throughout the calculation. Use `BigInt` in JavaScript or `int` in Python to add the non-circulating balances and subtract them from the total supply as integers. Convert the final result to whole XEM only for display, using integer division and modulo to format the whole and fractional parts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.