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

[doc]: Add create workspace doc #13766

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

heisen-li
Copy link
Contributor

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)

@rustbot
Copy link
Collaborator

rustbot commented Apr 17, 2024

r? @epage

rustbot has assigned @epage.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 17, 2024
src/doc/src/SUMMARY.md Outdated Show resolved Hide resolved
@heisen-li heisen-li marked this pull request as ready for review April 18, 2024 12:33
Copy link
Member

@weihanglo weihanglo left a 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.

src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
src/doc/src/guide/creating-a-new-workspace.md Outdated Show resolved Hide resolved
Comment on lines 9 to 11
- 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.
Copy link
Contributor

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

Copy link
Contributor Author

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.

@heisen-li
Copy link
Contributor Author

Is there anything else that needs to be changed on this, please?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants