Skip to content

Commit ac676f1

Browse files
committed
[wip]: Bring README.md in line with the RFC process
1 parent 38da57a commit ac676f1

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
# A Place for RFCs
2-
This is a repository for drafting, discussing and preparing community RFCs before proposing them on [typst/typst][typst] as a whole.
1+
# Community Standards RFCs
2+
This is a repository for drafting, discussing and preparing community standards though the RFC process.
3+
Community RFCs propose standards to implement by community projects with the goal of making the Typst experience consistent and predictable for end users.
34

4-
## Contributing
5-
TBD: The exact process shall be decided on the [official Typst community discord][discord] under 💬 forge > Community.
5+
We aim to standardize especially the interfaces between various projects in order to make especially tools and packages interoperable and compatible.
6+
7+
## A motivating Example
8+
A classic example for a community standard is the doc comment syntax used by [tinymist], originally introduced by [tidy].
9+
This syntax is not yet supported by Typst and may go through changes before it will, but is already widely used by the community because of the early support by tinymist.
610

7-
There's a short adapted version of the [rust-lang/rfcs][rust] RFC template for now, but this may change in the future.
11+
The standardization of this doc syntax would give the community the confidence that this syntax will be supported by community tools and packages without built-in support by the Typst compiler itself.
12+
It would allow also for the design of the syntax to be influenced by a broader set of stakeholders though an open discussion and revision process.
13+
14+
## Contributing
15+
To propose a standard is to create an RFC and have it accepted (merged) into this repository.
16+
The process for creating, revising and implementing an RFC is laid out in [`docs/process.md`][process].
817

918
## License
1019
All RFCs and other content in this repository is dual-licensed under MIT or Apache 2.0 (`SPDX-License-Identifier: MIT OR Apache-2.0`).
1120

12-
[typst]: https://github.com/typst/typst
13-
[discord]: https://discord.com/invite/y4Fhb6mvDa
14-
[rust]: https://github.com/rust-lang/rfcs
21+
[tinymist]: https://github.com/Myriad-Dreamin/tinymist
22+
[tidy]: https://github.com/Mc-Zen/tidy
23+
24+
[process]: ./docs/process.md

0 commit comments

Comments
 (0)