Skip to content

Reorganise and clean up the whole guide. #56

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

Merged
merged 4 commits into from
Jun 26, 2023
Merged

Reorganise and clean up the whole guide. #56

merged 4 commits into from
Jun 26, 2023

Conversation

m-ou-se
Copy link
Member

@m-ou-se m-ou-se commented Jun 24, 2023

This reorganises the guide and removes a lot of stub sections.

m-ou-se added 3 commits June 24, 2023 18:40
There's almost no information in there. We can add it back when we have
anything useful to say.
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this gets rid of a lot of the "broken windows", thanks :) reading the diff it does strike me that the "for reviewers" sections were acting as little summaries where you only have to read the bullet points rather than the whole section, but maybe people weren't using them? i don't feel strongly about keeping them around.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, this file seems useful - do you link something like it elsewhere?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's outdated and will be replaced by a new policy. See #55

Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😍

@m-ou-se m-ou-se merged commit 8ef36b8 into master Jun 26, 2023
@m-ou-se m-ou-se deleted the update branch June 26, 2023 16:53
github-actions bot pushed a commit that referenced this pull request Jun 26, 2023
@m-ou-se
Copy link
Member Author

m-ou-se commented Jun 26, 2023

@rust-lang/libs This reorganises and cleans up the std-dev-guide a bit. We had a lot of nearly empty pages and a structure that made it somewhat hard to just incrementally add new information. I removed all empty stubs and not-so-useful information and tried to categorize what remained into simpler categories. ("how to contribute", "policies", "team", etc.)

See https://std-dev-guide.rust-lang.org/

I'm not particularly tied to this structure/categorization; it's just what seemed to work well for the information we currently have. Feel free to move everything around if you think another structure works better. :)

I might have accidentally also removed some things I miscategorized as unuseful, as I tried to err a bit on the side of cleaning up too much rather than cleaning up too little, considering the amount of incomplete and outdated info there was. ^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants