New documentation#826
Draft
segfaultxavi wants to merge 49 commits into
Draft
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
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.
Adapts the Symbol [Monitoring Transaction Status](https://docs.symboltest.net/en/devbook/transactions/monitoring-status/) tutorial to NEM. The resulting tutorial is substantially different from Symbol. NEM validates transactions at announcement time, so most rejections surface directly in the announce response. Then, tracking if confirmed is more or less trivial with the `/transaction/get` endpoint. However, if the transaction does not get confirmed, tracking its status if far more complex than Symbol, because: - There is no endpoint to know if a transaction left the unconfirmed pool. - `/account/unconfirmedTransactions` returns at most the 25 most recent entries per address, with no pagination, leading to probable false negatives. - `/account/unconfirmedTransactions` response omits transaction hashes, so entries must be matched by signature. For these reasons, the tutorial focuses on explaining the confirmation flow and the mechanisms NEM does provide, rather than offering a complete reusable status function. The two takeaways for readers are how to detect that a transaction is confirmed or still pending to be processed, and how to decide that it will not be longer be confirmed (its deadline has passed, so it can never be included in a block). --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [get mosaic information](https://docs.symboltest.net/en/devbook/mosaics/get-mosaic-info/) tutorial to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [get namespace information](https://docs.symboltest.net/en/devbook/namespaces/get-namespace-info/) tutorial to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [query chain height](https://docs.symboltest.net/en/devbook/chain/chain-heights/) tutorial to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [Query Currency Supply](https://docs.symboltest.net/en/devbook/network-currency/query-currency-supply/) tutorial to NEM.
Adds a tutorial to transfer mosaics that builds on #883 --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Under the title instead of on the side, so it uses up less space.
Otherwise, it's taken from the page's H1 header, which now contains the tutorial complexity tag.
Adapts [query block rewards](https://docs.symboltest.net/en/devbook/network-currency/query-block-rewards/) tutorial to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Adapts [WebSockets reference](https://docs.symboltest.net/en/devbook/reference/websockets/) to NEM.
Adapt [listen new blocks](https://docs.symboltest.net/en/devbook/websockets/listen-new-blocks/) tutorial to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>
Moves the anchor icon that appears on hover next to title instead of next to the tutorial level badge in tutorials. Also reduces the spacing between the badge and the main text a bit.
Adapt [Typed Descriptors](https://docs.symboltest.net/en/devbook/transactions/typed-descriptors/) tutorial to NEM. --------- Co-authored-by: Xavi Artigas <xavierartigas@yahoo.es>
Address review comments from @Jaguar0625 on June 18.
Adapts [Listen tx flow](https://docs.symboltest.net/en/devbook/websockets/listen-transaction-flow/) tutorial to NEM and documents missing websocket channels and requests.
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.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #826 +/- ##
============================================
- Coverage 93.57% 93.55% -0.02%
+ Complexity 6078 6077 -1
============================================
Files 719 719
Lines 17372 17372
Branches 1313 1313
============================================
- Hits 16255 16252 -3
- Misses 864 867 +3
Partials 253 253
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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.