Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refine use of certain terms to better match expectations #2672

Closed
emmazzz opened this issue Jun 23, 2022 · 8 comments · Fixed by #3085, #3087, #3088, #3089 or #3092
Closed

Refine use of certain terms to better match expectations #2672

emmazzz opened this issue Jun 23, 2022 · 8 comments · Fixed by #3085, #3087, #3088, #3089 or #3092
Labels
Priority: Medium A nice to have feature or annoying bug, non-blocking and no delays expected if we punt on it Type: Documentation Improvements or additions to documentation
Milestone

Comments

@emmazzz
Copy link
Contributor

emmazzz commented Jun 23, 2022

Since Sui doesn't have a concept of "account" natively, it might make sense to consistently use "address" in docs and possibly other places to avoid confusion.

@emmazzz emmazzz added the Type: Documentation Improvements or additions to documentation label Jun 23, 2022
@Clay-Mysten Clay-Mysten added the Priority: Medium A nice to have feature or annoying bug, non-blocking and no delays expected if we punt on it label Jun 23, 2022
@Clay-Mysten
Copy link
Contributor

Thanks so much, Emma! Let me take first run at fixing this.

@Clay-Mysten
Copy link
Contributor

Hi @emmazzz , I am attaching a text file containing all of the references to all forms of "account" in docs.sui.io.
account-refs.txt

Please take a look and let me know if you have guidance for which references should remain. If not, I will use my own judgement and get plenty of review. Thanks!

@Clay-Mysten Clay-Mysten changed the title Use "address" instead of "account" in docs Refine use of certain terms to better match expectations Jul 8, 2022
@Clay-Mysten
Copy link
Contributor

I am making this issue more general to also take on related work. In addition to:

  1. the Use "address" instead of "account" in docs issue reported here
  2. we're also addressing the claims Sam indicated needing toning down in the Learn section as reported in Discord here:
    https://discord.com/channels/916379725201563759/955861929346355290/994891241324019752
    See the attached "most" references as a starting point.
  3. finally, I am trying to standardize on *net capitalization throughout the site in:
    Standardize FAQ on Devnet, Mainnet, Testnet #3085
    Standardize on Devnet capitalization in navigation #3086
    Standardize on Devnet capitalization in Devnet doc #3087
    Standardize on Devnet capitalization in Contribute index #3088
    Standardize on Devnet capitalization in Fullnode doc #3089
    Standardize json-rpc doc on Devnet, Mainnet, Testnet #3090
    Standardize on Devnet capitalization in Install doc #3091
    Standardize on Devnet capitalization in CLI Client doc #3092

@Clay-Mysten
Copy link
Contributor

most-refs.txt

@Clay-Mysten
Copy link
Contributor

And "common" for "simple" too
common-refs.txt
.

@Clay-Mysten
Copy link
Contributor

Reopening since we did not address the original request in #1, Use "address" instead of "account" in docs issue reported here

@Clay-Mysten
Copy link
Contributor

Asking @randall-Mysten to help with the outlier in #1 above.

@Clay-Mysten Clay-Mysten added this to the [C] Wave 2 milestone Aug 10, 2022
@Clay-Mysten
Copy link
Contributor

Clay-Mysten commented Aug 17, 2022

Hi Emma,

I have finally gotten around to tackling the original account > address swap you requested in:
#4108

Please note, this change should get careful review so I don't unintentionally change the meaning of our docs. I've added numerous folks to the PR to help.

Finally, please note I left many seemingly relevant references to accounts in many pages, most notably:
https://docs.sui.io/build/devnet
https://docs.sui.io/contribute/cli-client

This is required because we have output like this in our code:
Owner: Account Address ( 9E9A9D406961E478AA80F4A6B2B167673F3DF8BA )

So some concept of account exists. :-) That said, I reduced many references of "account address" to "address" per your recommendation. Please take a look. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment