Skip to content

Commit c7966f9

Browse files
authored
Merge pull request #11646 from Turbo87/docs
Update/Remove outdated documentation
2 parents a3ad072 + ab74432 commit c7966f9

File tree

4 files changed

+7
-214
lines changed

4 files changed

+7
-214
lines changed

docs/ARCHITECTURE.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Documentation about the codebase appears in these locations:
1818

1919
The backend of crates.io is written in Rust. Most of that code lives in the _src_ directory. It
2020
serves a JSON API over HTTP, and the HTTP server interface is provided by the [axum][] crate and
21-
related crates. More information about the backend is in
22-
[`docs/BACKEND.md`](https://github.com/rust-lang/crates.io/blob/master/docs/BACKEND.md).
21+
related crates. More information about backend development is in
22+
[`docs/CONTRIBUTING.md`](https://github.com/rust-lang/crates.io/blob/master/docs/CONTRIBUTING.md).
2323

2424
[axum]: https://crates.io/crates/axum
2525

@@ -37,8 +37,7 @@ The backend stores information in a Postgres database.
3737

3838
## Frontend - Ember.js
3939

40-
The frontend of crates.io is written in JavaScript using [Ember.js][]. More information about the
41-
frontend is in [`docs/FRONTEND.md`](https://github.com/rust-lang/crates.io/blob/master/docs/FRONTEND.md).
40+
The frontend of crates.io is written in JavaScript using [Ember.js][]. More information about frontend development is in [`docs/CONTRIBUTING.md`](https://github.com/rust-lang/crates.io/blob/master/docs/CONTRIBUTING.md).
4241

4342
[Ember.js]: https://emberjs.com/
4443

docs/BACKEND.md

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

docs/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ a documentation comment on it, it'd be great if you could add one to it too.
3636

3737
When you submit a pull request, it will be automatically tested on GitHub Actions. In
3838
addition to running both the frontend and the backend tests described below,
39-
GitHub Actions runs [jslint], [clippy], and [rustfmt] on each PR.
39+
GitHub Actions runs [ESLint], [clippy], and [rustfmt] on each PR.
4040

4141
If you don't want to run these tools locally, please watch the GitHub Actions results
4242
and submit additional commits to your pull request to fix any issues they find!
@@ -47,7 +47,7 @@ instructions and the [.github/workflows/ci.yml] file in this repository for the
4747
installation and running instructions. The logs for recent builds in GitHub Actions
4848
may also be helpful to see which versions of these tools we're currently using.
4949

50-
[jslint]: http://jslint.com/
50+
[ESLint]: https://eslint.org/
5151
[clippy]: https://github.com/rust-lang-nursery/rust-clippy
5252
[rustfmt]: https://github.com/rust-lang-nursery/rustfmt
5353
[.github/workflows/ci.yml]: /.github/workflows/ci.yml
@@ -104,7 +104,7 @@ as well.
104104

105105
In order to run the frontend on Windows and macOS, you will need to have installed:
106106

107-
- [node](https://nodejs.org/en/) >= 18.16.0 (see `package.json` and `.github/workflows/ci.yml` for what we currently use)
107+
- [node](https://nodejs.org/en/) (see `package.json` engines field for the exact version required)
108108
- [pnpm](https://pnpm.io) >= 8.5.1
109109

110110
Follow the links for each of these tools for their recommended installation
@@ -155,7 +155,7 @@ pnpm test
155155

156156
In order to run the backend, you will need to have installed:
157157

158-
- [Rust](https://www.rust-lang.org/en-US/) stable >= 1.56.0 and cargo, which comes with Rust
158+
- [Rust](https://www.rust-lang.org/en-US/) stable (see `rust-toolchain.toml` for version) and cargo, which comes with Rust
159159
- [Postgres](https://www.postgresql.org/) >= 9.5
160160
- [OpenSSL](https://www.openssl.org/) >= 1.0.2k
161161
- [diesel_cli](http://diesel.rs/guides/getting-started/) >= 2.0.0 and < 3.0.0

docs/FRONTEND.md

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

0 commit comments

Comments
 (0)