Skip to content

Commit 671ffca

Browse files
committed
Add type system docs 2025h2 goal
1 parent 8545974 commit 671ffca

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

src/2025h2/typesystem-docs.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Type System Documentation
2+
3+
| Metadata | |
4+
|:-----------------|----------|
5+
| Point of contact | @BoxyUwU |
6+
| Teams | |
7+
| Task owners | @BoxyUwU |
8+
| Status | Proposed |
9+
| Tracking issue | |
10+
| Zulip channel | N/A |
11+
12+
## Summary
13+
14+
Improve documentation of type system components to aide in types team onboarding and communication about changes to the type system .
15+
16+
## Motivation & Status Quo
17+
18+
The type system is a very complex and critical component of the compiler. It is currently lacking in documentation, and the documentation that *does* exist is often inadequate for gaining a thorough understanding of a given part of the type system (or simply outdated as it was written many years ago).
19+
20+
The lack of documentation makes onboarding difficult for new contributors and require a lot of energy from experienced contributors who are now responsible for explaining everything from scratch themselves. A similar problem also occurs when reviewing changes to the type system, as there is no documentation it can be difficult to bring everything back into cache and be confident that the subtleties of the area being changed have all been taken into account.
21+
22+
### The next 6 months
23+
24+
- Compile a list of type system concepts then compare that against the in-compiler documentation and the rustc-dev-guide's type system chapter to find weak points in our documentation.
25+
- Document existing known weak points:
26+
- How const generic arguments are type checked
27+
- The design of the new solver and how/why it differs from the old solver
28+
29+
### The "shiny future" we are working towards
30+
31+
All type system components should be thoroughly documented. Contributors should not find themselves in a position where knowledge of the type system is *only attainable by speaking with types team members instead of having readily available documentation to read.
32+
33+
## Ownership and team asks
34+
35+
| Task | Owner(s) or team(s) | Notes |
36+
|------------------------------|---------------------|-------|
37+
| Triage Analysis Chapter | @BoxyUwU | |
38+
| Const Generics Documentation | @BoxyUwU | |
39+
| New Solver Documentation | @BoxyUwU @lcnr | |

0 commit comments

Comments
 (0)