Skip to content

Cleanup the repo a little bit after Rust Reference decision #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 0 additions & 29 deletions .github/workflows/ci.yml

This file was deleted.

27 changes: 0 additions & 27 deletions .github/workflows/publish-mdbook-spec.yml

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore

This file was deleted.

8 changes: 0 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,3 @@
> on [Zulip] if you are interested in participating.

[Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/399173-t-spec

## Building

See the [Building docs](README.md#building) for information on generating HTML from the specification source files.

## Authoring guide

See the [Authoring Guide](docs/authoring.md) for information about working with the specification source files.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,12 @@
# The Rust Specification

## Building
## The Spec and the Rust Reference

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

```sh
mdbook build
```
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.

This will output the HTML into a directory called `book`.

For authors, consider using the server functionality which supports automatic reload:

```sh
mdbook serve --open
```

This will open a browser with a websocket live-link to automatically reload whenever the source is updated.

[mdBook]: https://rust-lang.github.io/mdBook/
[mdBook Insallation]: https://rust-lang.github.io/mdBook/guide/installation.html
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.

## License

Expand Down
14 changes: 0 additions & 14 deletions book.toml

This file was deleted.

167 changes: 0 additions & 167 deletions css/custom.css

This file was deleted.

79 changes: 0 additions & 79 deletions docs/authoring.md

This file was deleted.

1 change: 0 additions & 1 deletion mdbook-spec/.gitignore

This file was deleted.

13 changes: 0 additions & 13 deletions mdbook-spec/CHANGELOG.md

This file was deleted.

Loading