-
Notifications
You must be signed in to change notification settings - Fork 2.6k
[doc]: Add create workspace doc #13766
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
base: master
Are you sure you want to change the base?
Conversation
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.
Just skimmed through. Some minor suggestions added.
- The crate namespace at the Cargo level is flat. The tree layout creates another hierarchy and increases the possibility of inconsistencies. | ||
- With a flat structure, adding or splitting crates is very easy. | ||
- Even larger flattened lists are easier to see at a glance and easier to maintain than smaller tree structures. |
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.
This feels like its blurring the line between a guide-level document and the best practices examples that would hang off the reference.
Seeing this proposed document, I feel like its not pulling enough weight and I wonder if we should first focus in that examples / practices document
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.
Perhaps you mean that if add this section it might become a best practice type of article rather than an instructional one. Then I have adjusted the article to make it more suitable as an instructional article for newbies.
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.
Is there anything else that needs to be changed on this, please?
That went in the opposite direction of what I was suggesting. I'll have to give this more time to think about this to avoid any bias from my own way of wanting to do things.
000267d
to
4e4d429
Compare
Is there anything else that needs to be changed on this, please? |
[package] | ||
name = "new_workspace" | ||
version = "0.1.0" | ||
edition = "2021" |
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.
This feels odd because new_workspace
is actually a package. The step-by-step guide is not an ideal workflow, and even more confusing at this moment. Admittedly this is the tool's failure #8365. I wonder if we want to block this on that.
What does this PR try to resolve?
The second part of #13580.
There was a discussion in the previous issue and it looks like there are preliminary results?
Reference:
#13580 (comment)
#13580 (comment)