Skip to content

Commit 1f8f999

Browse files
committed
update to the new template
1 parent 25fc13f commit 1f8f999

File tree

13 files changed

+84
-37
lines changed

13 files changed

+84
-37
lines changed

CHARTER.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,10 @@
88

99
## Membership
1010

11-
* **Owner:** jackh726
12-
* **Liaison:** nikomatsakis
11+
| Role | Github |
12+
| --- | --- |
13+
| [Owner] | [jackh726](https://github.com/jackh726/) |
14+
| [Liaison] | [nikomatsakis](https://github.com/nikomatsakis/) |
15+
16+
[Owner]: https://lang-team.rust-lang.org/initiatives/process/roles/owner.html
17+
[Liaison]: https://lang-team.rust-lang.org/initiatives/process/roles/liaison.html

FAQ.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 😕 FAQ

README.md

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,58 @@
1-
# Generic Associated Types Initiative
1+
# Generic Associated Types initiative
22

3-
![project group status: active](https://img.shields.io/badge/status-active-brightgreen.svg)
4-
[![project group documentation](https://img.shields.io/badge/MDBook-View%20Documentation-blue)][gh-pages]
3+
<!--
4+
Status badge advertising the project as being actively worked on. When the
5+
project has finished be sure to replace the active badge with a badge
6+
like: https://img.shields.io/badge/status-archived-grey.svg
7+
-->
8+
![initiative status: active](https://img.shields.io/badge/status-active-brightgreen.svg)
59

6-
Welcome to the repository for the Generic Associated Types [initiative]! This is the repository we use to organise our work. Please refer to our [charter] as well
7-
as our [github pages website][gh-pages] for more information on our goals and
8-
current scope.
10+
## What is this?
11+
12+
This page tracks the work of the Generic Associated Types [initiative]! To learn more about what we are trying to do, and to find out the people who are doing it, take a look at the [charter].
913

10-
[initiative]: https://lang-team.rust-lang.org/initiatives.html
1114
[charter]: ./CHARTER.md
12-
[gh-pages]: https://rust-lang.github.io/{{GROUP_SLUG}}
15+
[initiative]: https://lang-team.rust-lang.org/initiatives.html
1316

14-
## How Can I Get Involved?
17+
## Current status
18+
19+
The following table lists of the stages of an initiative, along with links to the artifacts that will be produced by the start of that stage.
1520

16-
* We are not looking for coding support at this time.
17-
* You may wish to submit experience reports or participate in active discussions, however, please visit our [issues page](/issues).
21+
| Stage | State | Artifact(s) |
22+
| ------------------------------------- | ----- | ----------- |
23+
| [Proposal] || [Charter](./CHARTER.md) |
24+
| | | [Tracking issue](https://github.com/rust-lang/rust/) |
25+
| [Experimental] || [RFC](./RFC.md) |
26+
| [Development] | 🦀 | [Explainer](./explainer.md) |
27+
| [Feature complete] | 💤 | Stabilization report |
28+
| [Stabilized] | 💤 | |
29+
30+
[Proposal]: https://lang-team.rust-lang.org/initiatives/process/stages/proposal.html
31+
[Experimental]: https://lang-team.rust-lang.org/initiatives/process/stages/proposal.html
32+
[Development]: https://lang-team.rust-lang.org/initiatives/process/stages/development.html
33+
[Feature complete]: https://lang-team.rust-lang.org/initiatives/process/stages/feature-complete.html
34+
[Stabilized]: https://lang-team.rust-lang.org/initiatives/process/stages/stabilized.html
35+
36+
Key:
37+
38+
* ✅ -- phase complete
39+
* 🦀 -- phase in progress
40+
* 💤 -- phase not started yet
41+
42+
## How Can I Get Involved?
1843

19-
If you'd like to participate be sure to check out any of our [open issues] on this repository.
44+
* Check for "help wanted" issues on this repository!
45+
* If you would like to help with development, please contact the [owner](./charter.md#membership) to find out if there are things that need doing.
46+
* If you would like to help with the design, check the list of active [design questions](./design-questions/README.md) first.
47+
* If you have questions about the design, you can file an issue, but be sure to check the [FAQ](./FAQ.md) or the [design-questions](./design-questions/README.md) first to see if there is already something that covers your topic.
48+
* If you are using the feature and would like to provide feedback about your experiences, please [open a "experience report" issue].
49+
* If you are using the feature and would like to report a bug, please open a regular issue.
2050

21-
We also chat in the `#wg-traits` stream on the [rust-lang Zulip], feel free to introduce yourself over there and ask us any questions you have.
51+
We also participate on [Zulip][chat-link], feel free to introduce yourself over there and ask us any questions you have.
2252

23-
[rust-lang Zulip]: https://rust-lang.zulipchat.com/
53+
[open issues]: /issues
54+
[chat-link]: https://rust-lang.zulipchat.com/#narrow/stream/144729-wg-traits
55+
[team-toml]: https://github.com/rust-lang/team/blob/master/teams/initiative-gats.toml
2456

2557
## Building Documentation
2658
This repository is also an mdbook project. You can view and build it using the

RFC.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# ✨ RFC
2+
3+
[RFC #1598](https://github.com/rust-lang/rfcs/pull/1598)

SUMMARY.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Summary
22

3-
- [Welcome](./README.md)
4-
- [Charter](./CHARTER.md)
5-
- [Meetings](./meetings/README.md)
6-
- [Draft RFCs](./draft-rfcs/README.md)
7-
- [Discussion summaries](./discussion-summaries/README.md)
8-
- [Outlives defaults](./discussion-summaries/outlives-defaults.md)
9-
- [Where does the where clause go?](./discussion-summaries/where-the-where.md)
3+
- [👋 Welcome](./README.md)
4+
- [📜 Charter](./CHARTER.md)
5+
- [📚 Explainer](./explainer.md)
6+
- [✨ RFC](./RFC.md)
7+
- [💬 Design discussions](./design-discussions/README.md)
8+
- [💬 Outlives defaults](./design-discussions/outlives-defaults.md)
9+
- [💬 Where does the where clause go?](./design-discussions/where-the-where.md)
10+
- [😕 FAQ](./FAQ.md)

book.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,8 @@ title = "Generic Associated Types Initiative"
77

88
[output.html]
99
no-section-label=true
10-
git-repository-url="https://github.com/rust-lang/{{GROUP_SLUG}}"
10+
git-repository-url="https://github.com/rust-lang/generic-associated-types-initiative"
11+
12+
[output.html.fold]
13+
enable = true
14+
level = 0

design-discussions/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Design discussions
2+
3+
This directory hosts notes on important design discussions along with their resolutions.
4+
In the table of contents, you will find the overall status:
5+
6+
* ✅ -- **Settled!** Input only needed if you have identified a fresh consideration that is not covered by the write-up.
7+
* 💬 -- **Under active discussion.** Check the write-up, which may contain a list of questions or places where feedback is desired.
8+
* 💤 -- **Paused.** Not under active discussion, but we may be updating the write-up from time to time with details.
9+

discussion-summaries/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

draft-rfcs/README.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

explainer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 📚 Explainer
2+
3+
> The "explainer" is "end-user readable" documentation that explains how to use the feature being deveoped by this initiative.
4+
> If you want to experiment with the feature, you've come to the right place.
5+
> Until the feature enters "feature complete" form, the explainer should be considered a work-in-progress.

meetings/README.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)