-
Notifications
You must be signed in to change notification settings - Fork 11.3k
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
Conversation
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
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:
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. |
There was a problem hiding this 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.
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>
Move
git clone
command to Contribute in prep for removal from tutorialAdd link to Install docs for getting binaries