docs: update Namespaces page & fix minor typos
#2599
Conversation
There was a problem hiding this comment.
Solid changes. A few things should be fixed and I'd like some input on how we should be referring to packages, pure packages, and realms -- and do so consistently. Of course, that might be out of scope for this PR so we could always punt that particular item to another issue.
|
|
||
| # Package Paths | ||
|
|
||
| A package path is a unique identifier for each package/realm. It specifies the |
There was a problem hiding this comment.
I don't think there needs to be package/realm everywhere. We can just refer to them generally as packages and make the distinction between pure packages and realms when it is necessary.
Edit after looking through this and existing package docs more:
IMO we should refer to things throughout the docs as "pure packages" or "realms" as necessary and reserve "package" as a term that refers to both. This way the term "package path" makes sense that is should apply to both pure packages and realms, not only to what we currently refer to as packages (actually pure packages). What do you think?
| You can use a package path to: | ||
|
|
||
| - Call a specific function from a package/realm. (e.g using `gnokey maketx call`) | ||
| - Import it in other packages/realms. |
There was a problem hiding this comment.
| - Import it in other packages/realms. | |
| - Import it from other packages/realms. |
| - Domain: The domain of the blockchain where the package is deployed. | ||
| Currently, only `gno.land/` is supported. | ||
| - Type: Defines the type of package. | ||
| - `p/`: [Package](packages.md) |
There was a problem hiding this comment.
| - `p/`: [Package](packages.md) | |
| - `p/`: [Pure Package](packages.md) |
|
|
||
| :::warning Namespaces on gno.land testnets | ||
|
|
||
| This feature is currently only enabled on the [Test4 testnet](./testnets.md#test4). |
There was a problem hiding this comment.
Maybe reword this to clarify it is enabled on all networks from test4 and beyond, excluding portal loop. This way it won't have to be updated when we launch (test5? 😅 ) mainnet.
| ## Registering a namespace | ||
|
|
||
| To register a namespace, you need to use the `r/demo/users` realm. It allows | ||
| users to register a username for a fee of 200 `GNOTs`, which is in turn used as |
There was a problem hiding this comment.
| users to register a username for a fee of 200 `GNOTs`, which is in turn used as | |
| users to register a username, for a fee of 200 `GNOTs`, which is in turn used as |
Makes it clear that the username is the thing being used as a reference for the namespace of the user.
There was a problem hiding this comment.
Also, I've not typed out a lot of digital currency amounts in markdown, but it seems like 200 GNOT seems more natural than 200 GNOTs. I don't know of any other digital tokens where people use the plural of the token's symbol to reference more than one -- 5 "eth", 10 "sol", 7 "atom", etc.
| -gas-fee 1000000ugnot -gas-wanted 2000000 \ | ||
| -broadcast \ | ||
| -chainid=test4 \ | ||
| -remote https://rpc.test4.gno.land |
There was a problem hiding this comment.
| -remote https://rpc.test4.gno.land | |
| -remote https://rpc.test4.gno.land \ |
|
|
||
| After successful registration, you can add a package under your registered namespace. | ||
|
|
||
| ## Anonymous Namespace |
There was a problem hiding this comment.
I wouldn't describe the namespace as anonymous -- there is an address associated with it. Perhaps "Eponymous Namespace" is more fitting here.
| --gas-wanted 2000000 \ | ||
| --broadcast \ | ||
| --chainid test4 \ | ||
| -remote https://rpc.test4.gno.land |
There was a problem hiding this comment.
| -remote https://rpc.test4.gno.land | |
| --remote https://rpc.test4.gno.land \ |
Also when we have blocks of multiline commands in the same doc like this, it would be good to keep the flags consistent -- one dash vs two for example. You and I know there is no difference, but it might be confusing to a newbie just getting started with command line tools.
|
This PR is stale because it has been open 3 months with no activity. Remove stale label or comment or this will be closed in 3 months. |
Description
This PR updates the Namespaces page to make it more consistent and readable, and updates a few typos in relation to a few missed words in this PR. It renames the Namespaces page to
Package Paths.Matching docs PR: gnolang/docs.gno.land#50
Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description