Skip to content

Commit 3bc1315

Browse files
authored
Merge pull request #70 from JoelMarcey/repo-cleanup
Cleanup the repo a little bit after Rust Reference decision
2 parents 176bb6f + fab0b0c commit 3bc1315

21 files changed

+4
-1982
lines changed

.github/workflows/ci.yml

-29
This file was deleted.

.github/workflows/publish-mdbook-spec.yml

-27
This file was deleted.

.gitignore

-1
This file was deleted.

CONTRIBUTING.md

-8
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,3 @@
66
> on [Zulip] if you are interested in participating.
77
88
[Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/399173-t-spec
9-
10-
## Building
11-
12-
See the [Building docs](README.md#building) for information on generating HTML from the specification source files.
13-
14-
## Authoring guide
15-
16-
See the [Authoring Guide](docs/authoring.md) for information about working with the specification source files.

README.md

+4-17
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,12 @@
11
# The Rust Specification
22

3-
## Building
3+
## The Spec and the Rust Reference
44

5-
The specification uses [mdBook] to process the source into HTML. See [mdBook Installation] for more information on installing mdBook. To build the book, run:
5+
** The Rust specification is currently being developed as part of the [Rust Reference](https://github.com/rust-lang/reference).
66

7-
```sh
8-
mdbook build
9-
```
7+
The [`t-spec`](https://www.rust-lang.org/governance/teams/lang#team-spec) team, in consultation with interested parties from the Rust Project, made the decision on a [go-forward plan](https://hackmd.io/d-8LXh2NTASg7NF-zmZqNA?both#Review-go-forward-plan) that makes the Rust Reference the source of truth and the specification will be based on that content.
108

11-
This will output the HTML into a directory called `book`.
12-
13-
For authors, consider using the server functionality which supports automatic reload:
14-
15-
```sh
16-
mdbook serve --open
17-
```
18-
19-
This will open a browser with a websocket live-link to automatically reload whenever the source is updated.
20-
21-
[mdBook]: https://rust-lang.github.io/mdBook/
22-
[mdBook Insallation]: https://rust-lang.github.io/mdBook/guide/installation.html
9+
It is currently unclear what happens to both this repository and the Rust reference once we are at a steady-state of having a usable specification. It is likely we will consolidate the two repositories into one that ends up being called the specification. Stay tuned for more information on that.
2310

2411
## License
2512

book.toml

-14
This file was deleted.

css/custom.css

-167
This file was deleted.

docs/authoring.md

-79
This file was deleted.

mdbook-spec/.gitignore

-1
This file was deleted.

mdbook-spec/CHANGELOG.md

-13
This file was deleted.

0 commit comments

Comments
 (0)