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

rewrite compiler team documentation #804

Merged
merged 1 commit into from
Feb 25, 2025

Conversation

davidtwco
Copy link
Member

@davidtwco davidtwco commented Jan 31, 2025

cc @rust-lang/compiler

This is a rewrite/restructuring of all of our documentation in forge.rust-lang.org - I removed some content is removed because it was better suited to the dev guide, and shuffled around/updated most of the rest. I wasn't especially good at commit hygiene in this PR, so it's all a bit muddled together unfortunately.

Most notably, I've added a big section on what combination of RFC/MCP/FCP/r+ you need for any given change - which is something that we often find ambiguous. None of the decisions I've made in that section are necessarily final, just what I thought made sense - happy to adjust.

Rendered

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 31, 2025
@apiraino
Copy link
Contributor

apiraino commented Feb 3, 2025

removed some content [...] and shuffled around/updated most of the rest

I assume then there will be dead links. Which maybe should be handled in the book.toml file?

@jieyouxu
Copy link
Member

jieyouxu commented Feb 3, 2025

removed some content [...] and shuffled around/updated most of the rest

I assume then there will be dead links. Which maybe should be handled in the book.toml file?

Probably only if a redirection makes sense.

@apiraino
Copy link
Contributor

apiraino commented Feb 3, 2025

removed some content [...] and shuffled around/updated most of the rest

I assume then there will be dead links. Which maybe should be handled in the book.toml file?

Probably only if a redirection makes sense.

IMO Any dead link this patch is creating (if any) would make sense to be redirected (didn't look closely into that yet)

@apiraino
Copy link
Contributor

apiraino commented Feb 5, 2025

I've added a big section on what combination of RFC/MCP/FCP/r+ you need for any given change - which is something that we often find ambiguous

I focused a bit on these changes and I'm not yet fully sold about removing this content separation. Though the new version is very clear, will it be equally clear to the reader?

And at the same time search engine friendly. Right now our MCP page is the first clear hit I see on DuckDuckGo (and google)

Screenshot

grafik

just my .2 cents

@jieyouxu jieyouxu added T-compiler Team: Compiler S-waiting-on-team Status: Awaiting review/feedback/decision from relevant team(s) labels Feb 12, 2025
@davidtwco davidtwco force-pushed the update-compiler-team-docs branch 2 times, most recently from 90066ea to 7938880 Compare February 18, 2025 16:31
@davidtwco
Copy link
Member Author

I can look into adding redirects once we're happy with the content.

I've added a big section on what combination of RFC/MCP/FCP/r+ you need for any given change - which is something that we often find ambiguous
I focused a bit on these changes and I'm not yet fully sold about removing this content separation. Though the new version is very clear, will it be equally clear to the reader?

I think it is clearer to the reader, but if we wanted to try and solicit some feedback from team members who haven't looked at this yet, members of other teams, or just members of the community who might want to make a contribution and know what to do, then we can do that.

Copy link
Member

@jieyouxu jieyouxu left a comment

Choose a reason for hiding this comment

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

I have some more nits, but this looks good to me in general

Copy link
Contributor

@apiraino apiraino left a comment

Choose a reason for hiding this comment

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

thanks for this great work

@davidtwco davidtwco force-pushed the update-compiler-team-docs branch 2 times, most recently from b015136 to 19a50be Compare February 24, 2025 13:45
@davidtwco
Copy link
Member Author

Resolved all the feedback above and added redirects.

@davidtwco davidtwco force-pushed the update-compiler-team-docs branch from 19a50be to d109a29 Compare February 25, 2025 15:46
@davidtwco
Copy link
Member Author

Merging this so that we can base more documentation improvements on it, it's received reviews and approvals above.

@davidtwco davidtwco merged commit d9e63e0 into rust-lang:master Feb 25, 2025
1 check passed
@davidtwco davidtwco deleted the update-compiler-team-docs branch February 25, 2025 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. S-waiting-on-team Status: Awaiting review/feedback/decision from relevant team(s) T-compiler Team: Compiler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants