Skip to content

Commit

Permalink
rewrite compiler team documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
davidtwco committed Feb 17, 2025
1 parent cb5e0a0 commit 90066ea
Show file tree
Hide file tree
Showing 22 changed files with 1,240 additions and 1,355 deletions.
20 changes: 7 additions & 13 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,16 @@
- [Community](./community/README.md)
- [State of Rust Survey FAQ](./community/survey-faq.md)
- [Compiler](./compiler/README.md)
- [Cross Compilation](./compiler/cross-compilation/README.md)
- [Windows](./compiler/cross-compilation/windows.md)
- [Calendar](./compiler/calendar.md)
- [Cross-team Collaboration](./compiler/cross-team-collaboration.md)
- [Review policy](./compiler/reviews.md)
- [So you want to add a new option to rustc?](./compiler/new_option.md)
- [Major Change Proposals](./compiler/mcp.md)
- [Meetings](./compiler/meetings.md)
- [Membership](./compiler/membership.md)
- [Prioritization](./compiler/prioritization.md)
- [Procedure](./compiler/prioritization/procedure.md)
- [Priority Levels](./compiler/prioritization/priority-levels.md)
- [Notification groups](./compiler/notification-groups.md)
- [Triage Meeting](./compiler/triage-meeting.md)
- [Steering Meeting](./compiler/steering-meeting.md)
- [Submitting a proposal](./compiler/steering-meeting/submit.md)
- [How to run the planning meeting](./compiler/steering-meeting/how-to-run-planning.md)
- [How to run a design meeting](./compiler/steering-meeting/how-to-run-design.md)
- [Resources](./compiler/resources.md)
- [Review Policy](./compiler/reviews.md)
- [Proposals, Approval and Stabilization](./compiler/proposals-and-stabilization.md)
- [Third-party and Out-of-tree Crates Policy](./compiler/third-party-out-of-tree.md)
- [Triage and Prioritization](./compiler/prioritization.md)
- [crates.io](./crates-io/README.md)
- [Crate removal](./crates-io/crate-removal.md)
- [Database maintenance](./crates-io/db-maintenance.md)
Expand Down
38 changes: 24 additions & 14 deletions src/compiler/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
# Compiler
This section documents the Rust compiler itself, its APIs, and how to
contribute and provide bug fixes for the compiler.
Rust's compiler team are responsible for maintaining the Rust compiler, improving its performance
and considering the stabilization of compiler features.

### External Links
* The [Rustc Dev Guide] documents how the compiler works as well providing helpful
information to help get new contributors involved in the development.
* Rustc's [internal documentation].
* The [Compiler team] website is the home for all of the compiler
team's planning.
* oli-obk's [FIXME page] lists all of the `FIXME` comments in the Rust compiler.
We use the Forge to document the team's processes, policies and working practices, if you'd like to
read about how the compiler works and instructions on how to set up a development environment,
you're looking for the [rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/).


[Compiler team]: https://rust-lang.github.io/compiler-team/
[FIXME page]: https://oli-obk.github.io/fixmeh/
[Rustc Dev Guide]: https://rustc-dev-guide.rust-lang.org/
[internal documentation]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
- [Calendar](./calendar.md)
- *How do I subscribe to the compiler team's calendar?*
- [Cross-team Collaboration](./cross-team-collaboration.md)
- *How do I request the help of the compiler team?*
- [Meetings](./meetings.md)
- *What meetings do the compiler team run and how can I attend?*
- [Membership](./membership.md)
- *What is expected of compiler team members and how do I join?*
- [Resources](./resources.md)
- *What useful resources are available for contributors and team members?*
- [Review Policy](./reviews.md)
- *How do I make a contribution which is easy to review? How do I start reviewing as a team member?*
- [Proposals, Approval and Stabilization](./proposals-and-stabilization.md)
- *How do I propose a change to the compiler team? What approval is necessary for my change?*
- [Third-party and Out-of-tree Crates Policy](./third-party-out-of-tree.md)
- *When can I add third-party crates to the compiler? When can I create a out-of-tree crate for
the compiler?*
- [Triage and Prioritization](./prioritization.md)
- *How are compiler issues triaged and prioritized?*
39 changes: 39 additions & 0 deletions src/compiler/calendar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Calendar
All of the compiler team's calendars are available in the Rust project's
[`rust-lang/calendar`][calendar_repo] repository.

## Adding new events
Any project member can submit a pull request to [add new events][add_event] or
[subcalendars][add_calendar], just assign the compiler team's leads as a reviewer for the pull
request.

## Subscribing to the calendar
The team's calendar is [distributed as an `ics` file][ics] that can be imported into your preferred
calendar application.

> You can copy the calendar link from below:
>
> `https://rust-lang.github.io/calendar/compiler.ics`
>
> Alternative links which do not include working groups are available on the
> [calendar repository][calendar_repo].
- Fastmail
- Open the Settings page. Go to "Calendars" on the left sidebar. Scroll down to the
"Subscriptions" section and paste the link to the [compiler team calendar][ics] into the
field and press "Subscribe to calendar".
- Google Calendar
- Press the "+" icon next to "Other Calendars" in the left sidebar. Select "From URL" and paste
the link to the [compiler team calendar][ics] into the field and press "Add calendar".
- Outlook Web
- Go to the Calendar using the icon on the left sidebar. Select "Add Calendar" on the left and
then "Subscribe from the web", paste the link to the [compiler team calendar][ics] into the
field and press "Import".

If your preferred calendar application isn't listed above, feel free to submit a pull request to
this documentation to add instructions above.

[add_calendar]: https://github.com/rust-lang/calendar?tab=readme-ov-file#how-do-i-add-a-calendar
[add_event]: https://github.com/rust-lang/calendar?tab=readme-ov-file#how-do-i-add-an-event
[calendar_repo]: https://github.com/rust-lang/calendar
[ics]: https://rust-lang.github.io/calendar/compiler.ics
2 changes: 0 additions & 2 deletions src/compiler/cross-compilation/README.md

This file was deleted.

31 changes: 0 additions & 31 deletions src/compiler/cross-compilation/windows.md

This file was deleted.

190 changes: 0 additions & 190 deletions src/compiler/mcp.md

This file was deleted.

Loading

0 comments on commit 90066ea

Please sign in to comment.