Skip to content

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
@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.

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.

Copy link
Contributor

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.

@heisen-li heisen-li force-pushed the workspace_example branch from 000267d to 4e4d429 Compare May 31, 2024 07:38
@heisen-li
Copy link
Contributor Author

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

Comment on lines +21 to +24
[package]
name = "new_workspace"
version = "0.1.0"
edition = "2021"
Copy link
Member

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.

@weihanglo
Copy link
Member

This PR has been stale for a while, and not in a good state of merging. I am going to close now. Thank you for being interested in improving documentations!

@weihanglo weihanglo closed this Aug 17, 2025
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 17, 2025
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants