Organize docs #687
Merged
Organize docs #687
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The README is getting long and confusing, and I want to add even more docs. Instead of just adding on, split up the readme into more files and link to them from the readme.
carols10cents
force-pushed
the
organize-docs
branch
from
0ae77f1 to
7475704
Compare
|
👍 |
|
@carols10cents sorry for the delay, it's finals week right now. To the project: it went perfectly for me! The only thing that came up and didn't line up entirely correctly is in the document it says |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At a recent OSS event that I helped out with, we discovered that the setup instructions were missing some things and were organized in a confusing way.
I wanted some room to elaborate, so I moved the dev setup instructions and the mirror setup instructions into their own files.
I also removed the instructions that the init-local-index.sh script printed out, since the instructions for setting up cargo there are confusing (ex: you should not put the
.cargo/configin your crates.io checkout and then try to build crates.io, which isn't clear) and out of date.Fixes #667.