namecoin / namecoin-core

Namecoin full node + wallet based on the current Bitcoin Core codebase.
https://www.namecoin.org/
MIT License
461 stars 147 forks source link

Standardize on names for documentation #356

Open yanmaani opened 4 years ago

yanmaani commented 4 years ago

Some of the documentation (e.g. for RPC commands) uses d/myname, some of it uses myname, some of it uses d/abc, and some of it uses d/domob.

It would be nice to standardize this. Just using myname without the d/ is confusing, but otherwise I don't have a strong opinion. I would suggest d/example, however it's squatted. d/namecoin might work. We could also use a specific namespace, like ex/domain, although this has some risk of confusion.

In upstream, there is a const std::string array EXAMPLE_ADDRESS with some (invalid) bech32 addresses. That is a good model of how to do it.

JeremyRand commented 2 years ago

Of these, I personally prefer d/namecoin or d/domob, but ACK on using a const std::string for this; we can bikeshed about which example name to use after it's factored out.