symbol / symbol-docs

Open-source documentation of Symbol
https://docs.symbol.dev
Apache License 2.0
56 stars 91 forks source link

Refer to mainnet as default #641

Open segfaultxavi opened 3 years ago

segfaultxavi commented 3 years ago

Docs only talked about testnet for a long time. Docs written after launch started talking about mainnet too, and now we have a mix.

All pages should be reviewed to make sure mainnet is referred too by default, and notes about testnet added when required (different URLs, or mechanisms, for example). Things to pay attention to:

dgarcia360 commented 2 years ago

How about the opposite (refer to testnet by default)?

One of the primary audiences for these docs is devs willing to integrate Symbol. In software development, devs usually test their solution locally and/or in pre before releasing it in prod (in this case, mainet).

Unlike with other systems, mistakes in blockchain can be costly, and it's hardly ever possible to go back to a previous state. For instance, imagine a newcomer buying XYM, playing with code examples, and announcing an unfortunate transaction with one more 0.

segfaultxavi commented 2 years ago

Hmmm... definitely something to think about. I think I agree with you.