docs: address review comments#918
Conversation
| The <get:/namespace/mosaic/definition/page> endpoint returns one definition for each mosaic whose namespace matches | ||
| the queried name exactly. | ||
| Mosaics defined under deeper subnamespaces (such as `foo.bar:baz` when querying `foo`) are not included. | ||
| To list those as well, repeat this query for each subnamespace found in the previous step. |
There was a problem hiding this comment.
not sure if you should show them as part of the tutorial?
@Jaguar0625 I decided not to add it to keep the tutorial simple. They can always repeat the query with the subnamespaces they get on the previous step. I added some guidance, though.
| @@ -80,134 +80,84 @@ The cycle repeats at the next block height. | |||
|
|
|||
| ## Harvesting Methods | |||
There was a problem hiding this comment.
This is the biggest edit now I understand the difference between remote harvesting and delegated harvesting.
Edited the section to make it more similar to Symbol, but decided to use a single term for "proxy account" and "remote account" for consistency -> "remote account". We might want to apply this edit to Symbol too.
| A single Java process that implements all node functionality. | ||
|
|
||
| NIS has four parts: an [engine](#engine), exposed by a [REST API](#rest-api) and a [WebSocket](#websocket) service, with an embedded [database](#database) for storage. | ||
| NIS has four parts: an [engine](#engine), a [REST API](#rest-api), a [WebSocket](#websocket) service, and an embedded |
There was a problem hiding this comment.
i'd also tend to call engine something else, like pipeline.
@Jaguar0625 I decided to keep it as "engine" represents the hard work (consensus, harvesting, etc.), whereas "pipeline" suggests more of a pass-through layer.
I know there's no actual "engine" module in NIS, but I had to come up with this concept for explanation purposes to help illustrate how things connect.
Let me know if "engine" is OK, or if you would prefer me to look for another term.
| {%- set ns.group_count = ns.group_count + 1 -%} | ||
| {%- endmacro %} | ||
|
|
||
| {# Renders a language-specific literal (e.g. Python True -> JavaScript true) as a language-switching dylink. #} |
There was a problem hiding this comment.
Added to map format vars like True -> true when changing the language selector.
I'll review if it's necessary in Symbol and port it too.
| : <Key pair:|Key pair> associated with every <account:>. | ||
| Its private key identifies the account owner and grants full control over the account, including the ability to | ||
| transfer funds and announce transactions. | ||
|
|
||
| Remote Key | ||
| : Key pair associated with an account that has delegated harvesting to a remote node (see <harvesting:>). | ||
| The remote key signs blocks on behalf of the main account without exposing the main private key. | ||
| : <Key pair:|Key pair> associated with every <remote harvesting:> account. | ||
| It allows a node to harvest on behalf of another account without exposing the account's <main key:>. |
There was a problem hiding this comment.
Edited to match latest Symbol version.
| be converted into a multisig. | ||
| Multisig hierarchies are therefore **one layer deep**. | ||
|
|
||
| ## Importance |
There was a problem hiding this comment.
Moved from "harvesting" as is.
1 participant
Address review comments from @Jaguar0625 on June 18.