New documentation by segfaultxavi · Pull Request #826 · NemProject/nem

segfaultxavi · 2026-04-07T16:16:12Z

No description provided.

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.

github-advanced-security AI found potential problems May 28, 2026

View reviewed changes

Comment thread mkdocs/snippets/devbook/accounts/create_from_mnemonic.py Dismissed

segfaultxavi and others added 29 commits June 29, 2026 10:41

Initial import

5b4aad6

[mkdocs] feat: allow disabling java ref pages

20a1395

[mkdocs] fix: patch mkdoxy plugin

5a96a7d

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] add: selected shield icons

8f53c61

[mkdocs] docs: add accounts and cryptography concepts (#838)

c6dbe9a

[mkdocs] add: mailmap file

d3c37a6

[mkdocs] docs: add transactions concept (#839)

3bd4b48

* [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] fix: update Material theme to support Python 3.14

983fc1b

Otherwise, we get deprecation warnings.

[mkdocs] docs: add namespace concept (#844)

acc1db1

* [mkdocs] docs: add namespace concept * [mkdocs] docs: apply comments * [mkdocs] docs: apply comments

[mkdocs] docs: add blocks concept (#848)

561ed7a

* [mkdocs] docs: add blocks concept * [mkdocs] docs: update sidebar

[mkdocs] docs: add mosaics concept (#846)

378f768

* [mkdocs] docs: add mosaics concept * [mkdocs] docs: apply comments

[mkdocs] docs: add consensus and harvesting concepts (#855)

3041c2b

* [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>

[mkdocs] docs: add cats concept (#865)

b201cca

[jenkins] Include sdk/ in Symbol submodule sparse checkout

e21837e

[docs] add: language selector page

2d30b87

[mkdocs] fix: make sure deploy script builds FULL docs

3f6ed90

[mkdocs] fix: update .mailmap

ccad7a4

[mkdocs] docs: add nodes concept (#864)

4be35e2

[mkdocs] docs: add serialization reference

8f81200

[mkdocs] docs: create accounts tutorials (#870)

a63e706

[mkdocs] docs: add faucet tutorial (#871)

333ca94

Adapts [faucet tutorial](https://docs.symboltest.net/en/devbook/accounts/testnet-faucet/) to NEM.

[mkdocs] docs: add query balance tutorial (#882)

a0936a2

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>

[mkdocs] docs: add transfer xem tutorial (#883)

127839a

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.

[mkdocs] fix: proper location of Transaction tutorials in TOC

e4e638c

[mkdocs] fix: CI setup_build script

79434c5

[mkdocs] fix: broken links

5f870c9

zero4862 and others added 14 commits June 29, 2026 10:41

[mkdocs] docs: add get mosaic information tutorial (#891)

32a3c29

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>

[mkdocs] docs: add get namespace information tutorial (#893)

023c1d3

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>

[mkdocs] docs: add query chain height (#894)

2bfca37

Adapts [query chain height](https://docs.symboltest.net/en/devbook/chain/chain-heights/) tutorial to NEM. --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>

[mkdocs] fix: enforce style guidelines

29b99cb

[mkdocs] docs: add query supply tutorial (#897)

631860a

Adapts [Query Currency Supply](https://docs.symboltest.net/en/devbook/network-currency/query-currency-supply/) tutorial to NEM.

[mkdocs] fix: clearer term for "burn"

1e38739

[mkdocs] docs: add transfer mosaic tutorial (#889)

fbe90f0

Adds a tutorial to transfer mosaics that builds on #883 --------- Co-authored-by: Xavi Artigas <xavi@symbolsyndicate.us>

[mkdocs] fix: move tutorial complexity tag (#899)

2ca9b64

Under the title instead of on the side, so it uses up less space.

[mkdocs] fix: always provide title in metadata

ec56f21

Otherwise, it's taken from the page's H1 header, which now contains the tutorial complexity tag.

[mkdocs] fix: setup page tweaks

b3af2a8

[mkdocs] docs: query block rewards tutorial (#898)

e9dcdc1

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>

[mkdocs] feat: add a STOMP pygments lexer

512dbb0

[mkdocs] docs: add websockets reference (#909)

f02cda1

Adapts [WebSockets reference](https://docs.symboltest.net/en/devbook/reference/websockets/) to NEM.

[mkdocs] docs: add listen new blocks tutorial (#910)

e0ac7c0

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>

segfaultxavi force-pushed the new-docs branch from 9b0f682 to e0ac7c0 Compare June 29, 2026 08:42

[mkdocs] docs: improve anchor positioning in tutorials (#920)

03cd30f

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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

New documentation#826

New documentation#826
segfaultxavi wants to merge 44 commits into
devfrom
new-docs

segfaultxavi commented Apr 7, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

segfaultxavi commented Apr 7, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants