Skip to content

Commit 052a345

Browse files
authored
Fix some template formatting (#209)
1 parent f3214a7 commit 052a345

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

docs/rfds/TEMPLATE.md renamed to docs/rfds/TEMPLATE.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: "INSERT RFD TITLE HERE"
3+
---
4+
15
<!--
26

37
Instructions:
@@ -10,23 +14,19 @@ Instructions:
1014

1115
-->
1216

13-
---
14-
15-
## title: "RFD TITLE"
16-
17-
# Elevator pitch
17+
## Elevator pitch
1818

1919
> What are you proposing to change?
2020

2121
<!--
2222
Give a brief, high-level overview of what you plan to do and what problem you are solving. Feel free to use bullet points to help clarify the structure.
2323
-->
2424

25-
# Status quo
25+
## Status quo
2626

2727
> How do things work today and what problems does this cause? Why would we change things?
2828

29-
# What we propose to do about it
29+
## What we propose to do about it
3030

3131
> What are you proposing to improve the situation?
3232
@@ -38,7 +38,7 @@ Instructions:
3838
You can also include multiple variants if you have different ideas of how to approach the problem, though these should be narrowed down as the RFD progresses.
3939
-->
4040

41-
# Shiny future
41+
## Shiny future
4242

4343
> How will things will play out once this feature exists?
4444

@@ -49,7 +49,7 @@ Instructions:
4949
Note: This section is OPTIONAL when RFDs are first opened.
5050
-->
5151

52-
# Implementation details and plan
52+
## Implementation details and plan
5353

5454
> Tell me more about your implementation. What is your detailed implementation plan?
5555

@@ -59,20 +59,20 @@ Instructions:
5959
Note: This section is OPTIONAL and NOT RECOMMENDED when RFDs are first opened. It can distract from the discussion of the problem.
6060
-->
6161

62-
# Frequently asked questions
62+
## Frequently asked questions
6363

6464
> What questions have arisen over the course of authoring this document or during subsequent discussions?
6565

6666
<!--
6767
Keep this section up-to-date as discussion proceeds. The goal is to capture major points that came up on a PR or in a discussion forum -- and if they reoccur, to point people to the FAQ so that we can start the dialog from a more informed place.
6868
-->
6969

70-
## What alternative approaches did you consider, and why did you settle on this one?
70+
### What alternative approaches did you consider, and why did you settle on this one?
7171

7272
None. The idea came to me fully formed, like Athena springing from Zeus's head.
7373

7474
<!-- You...may want to adjust this. -->
7575

76-
# Revision history
76+
## Revision history
7777

7878
<!-- If there have been major updates to this RFD, you can include the git revisions and a summary of the changes. -->

docs/rfds/introduce-rfd-process.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,78 +2,78 @@
22
title: "Introduce RFD Process"
33
---
44

5-
# Elevator pitch
5+
## Elevator pitch
66

77
> What are you proposing to change? Bullet points welcome.
88
99
Introduce a "Request for Dialog" (RFD) process to replace ad-hoc design discussions with structured, community-friendly design documents that track features from conception to completion.
1010

11-
# Status quo
11+
## Status quo
1212

1313
> How do things work today and what problems does this cause? Why would we change things?
1414
1515
Currently all development is being done primarily by the Zed team tracking requests and proposals from multiple teams. The goal is to create a process that helps to keep files organized and which can scale to participation by an emerging community.
1616

17-
# Shiny future
17+
## Shiny future
1818

1919
> How will things will play out once this feature exists?
2020
21-
## Project licensing
21+
### Project licensing
2222

2323
All code and RFDs are licensed under an Apache 2.0 license. The project is intended to remain open source and freely available in perpetuity.
2424

25-
## Decision making
25+
### Decision making
2626

2727
For the initial phase, the project shall have a "design team" that consists of the Zed team acting in "BDFL" capacity. The expectation is that the project will setup a more structure governance structure as it grows. The design team makes all decisions regarding RFDs and sets overall project direction.
2828

29-
## RFD lifecycle
29+
### RFD lifecycle
3030

31-
### RFDs are proposed by opening a PR
31+
#### RFDs are proposed by opening a PR
3232

3333
An RFD begins as a PR adding a new file into the "Draft" section. The RFD can start minimal - just an elevator pitch and status quo are enough to begin dialog. Pull requests become the discussion forum where ideas get refined through collaborative iteration.
3434

3535
As discussion proceeds, the FAQ of the RFD should be extended. If discussion has been going long enough, the PR should be closed, feedback summarized, and then re-opened with a link to the original PR.
3636

37-
### The PR is merged into "draft" once a core team member decides to champion it
37+
#### The PR is merged into "draft" once a core team member decides to champion it
3838

3939
RFD proposals are merged into the "draft" section if a core team member decides to champion them. The champion is then the point-of-contact for that proposal going forward and they will work with the proposal authors and others to make it reality. Core team members do not need to seek consensus to merge a proposal into the draft, but they should listen carefully to concerns from other core team members, as it will be difficult to move the RFD forward if those concerns are not ultimately addressed.
4040

4141
Once a proposal is moved to draft, code and implementation may begin to land into the PR. This work needs to be properly feature gated and marked with the name of the RFD.
4242

4343
Further discussion on the RFD can take place on Slack if needed.
4444

45-
### Moving to the "preview" section
45+
#### Moving to the "preview" section
4646

4747
Once the champion feels the RFD is ready for others to check it out, they can open a PR to move the file to the preview section. This is a signal to the community (and particularly other core team members) to check out the proposal and see what they think. The PR should stay open for "a few days" to give people an opportunity to leave feedback. The champion is empowered to decide whether to land the PR. As ever, all new feedback should be recorded in the FAQ section.
4848

49-
### Deciding to accept an RFD
49+
#### Deciding to accept an RFD
5050

5151
When they feel the RFD is ready to be completed, the champion requests review by the team. The team can raise concerns and notes during discussion. Final decision on an RFD is made by the core team lead.
5252

53-
### Implementation of an RFD
53+
#### Implementation of an RFD
5454

5555
Once accepted, RFDs become living documents that track implementation progress. Status badges in design documentation link back to the relevant RFD, creating a clear connection between "why we're building this" and "how it works." When building code with an agent, agents should read RFDs during implementation to understand design rationale and update them with implementation progress.
5656

57-
## Moderating and managing RFD discussions
57+
### Moderating and managing RFD discussions
5858

5959
Moving RFDs between points in the cycle involve opening PRs. Those PRs will be places to hold dialog and discussion -- but not the only place, we expect more detailed discussions to take place on Slack or other communication channels. RFD owners and champions should actively "curate" discussions by collecting questions that come up and ensuring they are covered in the FAQ. Duplicate questions can be directed to the FAQ.
6060

6161
If the discussion on the PR gets to the point where Github begins to hide comments, the PR should typically be closed, feedback collected, and then re-opened.
6262

63-
# Implementation plan
63+
## Implementation plan
6464

6565
> What is your implementation plan?
6666
6767
- ✅ Create RFD infrastructure (about, TEMPLATE, navigation setup)
6868
- ✅ Establish lifecycle: Draft → Preview → Accepted → Completed
6969
- ⏳ Write RFDs for major in-progress features
7070

71-
# Frequently asked questions
71+
## Frequently asked questions
7272

73-
## Why "Request for Dialog" and not "Request for Comment"?
73+
### Why "Request for Dialog" and not "Request for Comment"?
7474

7575
Well, partly because "dialog" emphasizes conversation and exploration rather than just collecting feedback on a predetermined design. We also shamelessly stole this process from [Niko Matsakis and the Symposium project](https://symposium-dev.github.io/symposium/rfds/index.html) (with permission) so that we could benefit from their experience.
7676

77-
# Revision history
77+
## Revision history
7878

7979
- 2025-10-28: Initial version, created alongside RFD infrastructure

0 commit comments

Comments
 (0)