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

Build out Contribute index with download instructions and descriptions of primary directories #1076

Merged
merged 6 commits into from
Mar 30, 2022

Conversation

Clay-Mysten
Copy link
Contributor

Move git clone command to Contribute in prep for removal from tutorial
Add link to Install docs for getting binaries

Move `git clone` command to Contribute in prep for removal from tutorial
Add link to Install docs for getting binaries
Identify, link to, and summarize contents of primary directories
@Clay-Mysten
Copy link
Contributor Author

Hi team,

Adam had the excellent idea of summarizing our primary directories in our Contribute page. I have taken a first step but would like your input. Feel free to commit changes directly or provide them in comments. And of course add missing reviewers. Thanks!

@awelc
Copy link
Contributor

awelc commented Mar 25, 2022

Hi team,

Adam had the excellent idea of summarizing our primary directories in our Contribute page. I have taken a first step but would like your input. Feel free to commit changes directly or provide them in comments. And of course add missing reviewers. Thanks!

Let me elaborate on this a bit more. The main motivation for this whole change is to balance two things out:

  1. We don't necessarily want people that just want to play with Sui via it's CLI (sui, wallet, etc.) to be forced to clone the entire repo as it's not really useful much for this kind of audience
  2. At the same time, in some docs we are referring to code in Sui's repo and ask people to "download" it somehow (e.g., Move code to be published for playing the TicTacToe game). In these cases it would be convenient to point people at some common location where we describe how to clone our repo.

The contribute section seems like a decent place to put repo cloning instructions as this file targets folks that actually need to inspect Sui's source code. Having bare-bones cloning instructions could be OK, but it just feels better to also include a very brief code structure blurb there as well.

Copy link
Contributor

@awelc awelc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stamped, but since this was already something that @Clay-Mysten and I discussed, it would be good to get at least one more opinion on this from someone that is not biased.

doc/src/contribute/index.md Outdated Show resolved Hide resolved
doc/src/contribute/index.md Outdated Show resolved Hide resolved
doc/src/contribute/index.md Outdated Show resolved Hide resolved
doc/src/contribute/index.md Outdated Show resolved Hide resolved
@huitseeker huitseeker added the Type: Documentation Improvements or additions to documentation label Mar 26, 2022
@Clay-Mysten Clay-Mysten changed the title Update index.md Build out Contribute index with download instructions and descriptions of primary directories Mar 28, 2022
Clay-Mysten and others added 4 commits March 30, 2022 08:26
Co-authored-by: Adam Welc <adam@mystenlabs.com>
Co-authored-by: Adam Welc <adam@mystenlabs.com>
Co-authored-by: Adam Welc <adam@mystenlabs.com>
Co-authored-by: Adam Welc <adam@mystenlabs.com>
@Clay-Mysten Clay-Mysten merged commit 63afa3d into main Mar 30, 2022
@Clay-Mysten Clay-Mysten deleted the Clay-Mysten-patch-19 branch March 30, 2022 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants