Skip to content

Commit 04ac683

Browse files
JoelMarceylqd
andauthored
2025H2 Project Goal Proposal: Develop the capabilities to keep the FLS up to date (#335)
* Integrate the FLS into Documentation Processes Now that that FLS is an official part of the Rust Project and we can publish the FLS independently of dependencies required in the past, let's see if we can integrate the FLS into the documentation processes on the same level as the Reference. * Updated based on internal `t-spec` team feedback * Rename proposal file * Update src/2025h2/FLS-up-to-date-capabilities.md Co-authored-by: Rémy Rakic <[email protected]> * Update src/2025h2/FLS-up-to-date-capabilities.md Co-authored-by: Rémy Rakic <[email protected]> * Update src/2025h2/FLS-up-to-date-capabilities.md Co-authored-by: Rémy Rakic <[email protected]> * Update FLS-up-to-date-capabilities.md Try to fix markdown errors. * Update FLS-up-to-date-capabilities.md Fix metadata table to pass validation * Update src/2025h2/FLS-up-to-date-capabilities.md Co-authored-by: Rémy Rakic <[email protected]> --------- Co-authored-by: Rémy Rakic <[email protected]>
1 parent e1ec32d commit 04ac683

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Develop the capabilities to keep the FLS up to date
2+
3+
| Metadata | |
4+
|:-----------------|----------------------------------------------------------------------------------|
5+
| Point of contact | @JoelMarcey |
6+
| Teams | <!-- TEAMS WITH ASKS --> |
7+
| Task owners | <!-- TASK OWNERS --> |
8+
| Status | Proposed |
9+
| Tracking issue | |
10+
| Zulip channel | #t-spec |
11+
12+
## Summary
13+
14+
Develop the capabilities and capacity to keep the FLS up to date with the Rust language.
15+
16+
## Motivation
17+
18+
The FLS was graciously transferred from Ferrous Systems to the Rust Project. In 2025H1, a [Project goal](https://rust-lang.github.io/rust-project-goals/2025h1/spec-fls-publish.html) to bring the FLS in and publish a version under the auspicious of the Rust Project was successfully [completed](https://github.com/rust-lang/rust-project-goals/issues/265#issuecomment-3019529070). Let's now take this to the next level by ensuring that we can keep the FLS up to date with the Rust language in a sustainable manner by developing the necessary capacity and capabilities for doing so.
19+
20+
### The status quo
21+
22+
The target audience here will be those that have a vested interest in Rust specification work and want to see movement forward in ensuring that our documents are as correct and complete as possible.
23+
24+
Keeping up with documentation is not always the most glamorous role for any project. And folks like @ehuss and others are doing an outstanding job at trying to keep the Reference current with actual code behavior. This is a hard job just for one document like the Reference. It will be even more difficult adding another core document like the FLS. But that doesn't necessarily mean we can't keep the FLS as up to date as is needed by its users.
25+
26+
### The next 6 months
27+
28+
Explore options for developing the capability to keep the FLS updated with the Rust language, in a sustainable way, at the cadence needed by its users.
29+
30+
The outcome of the next six months is variable. The entire six months could be investigative, with some prototyping. Or we could establish a concrete cadence and capacity for updating the FLS.
31+
32+
### The "shiny future" we are working towards
33+
34+
The shiny future we are working towards is to ensure that we have the capability in place to keep the FLS updated at the pace needed by its users.
35+
36+
## Ownership and team asks
37+
38+
**Owner:** @JoelMarcey, in his capacity of `t-spec` team member will lead this project goal.
39+
40+
| Task | Owner(s) or team(s) | Notes |
41+
|------------------------------------|--------------------------------|---------------------------------|
42+
| Discussion and moral support | ![Team][] [spec], [lang] | |
43+
| Adjust tooling, as needed | @JoelMarcey | Joel to find appropriate person |
44+
| Standard reviews | ![Team][] [lang],[opsem], [types], [bootstrap] | For any process changes, document updates and/or tooling integration |
45+
| Continued updates for the FLS | Contributors from Ferrous Systems and others TBD | |
46+
| Review of updates to the FLS | `t-spec` and contributors from Ferrous Systems | |
47+
48+
## Frequently asked questions
49+
50+
### Why this Project goal?
51+
52+
The goal is to ensure the FLS is updated sufficiently to meet the needs of its users.
53+
54+
### Can this be done in six months?
55+
56+
Don't know. But we need to start having the conversations and see where it can lead.
57+
58+
### Getting documentation updated is hard. Who would do that work?
59+
60+
This may be the biggest blocker to making this goal successful. Part of this goal will be finding people who are interested in doing the work to author and review these updates or to find the budget to hire people to do this.
61+
62+
### What happens if the FLS and Reference combine as one specification document?
63+
64+
That's actually a potential outcome of the `t-spec` work in the future. So this may not be totally theoretical. Hopefully the processes we come up with are not so document specific and they can withstand such a merger.

0 commit comments

Comments
 (0)