-
Notifications
You must be signed in to change notification settings - Fork 183
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
rewrite compiler team documentation #804
Conversation
I assume then there will be dead links. Which maybe should be handled in the |
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) |
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) just my .2 cents |
90066ea
to
7938880
Compare
I can look into adding redirects once we're happy with the content.
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. |
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.
I have some more nits, but this looks good to me in general
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.
thanks for this great work
b015136
to
19a50be
Compare
Resolved all the feedback above and added redirects. |
19a50be
to
d109a29
Compare
Merging this so that we can base more documentation improvements on it, it's received reviews and approvals above. |
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