Skip to content
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
7 changes: 3 additions & 4 deletions docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Documentation about the codebase appears in these locations:

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

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

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

## Frontend - Ember.js

The frontend of crates.io is written in JavaScript using [Ember.js][]. More information about the
frontend is in [`docs/FRONTEND.md`](https://github.com/rust-lang/crates.io/blob/master/docs/FRONTEND.md).
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).

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

Expand Down
199 changes: 0 additions & 199 deletions docs/BACKEND.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ a documentation comment on it, it'd be great if you could add one to it too.

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

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

[jslint]: http://jslint.com/
[ESLint]: https://eslint.org/
[clippy]: https://github.com/rust-lang-nursery/rust-clippy
[rustfmt]: https://github.com/rust-lang-nursery/rustfmt
[.github/workflows/ci.yml]: /.github/workflows/ci.yml
Expand Down Expand Up @@ -104,7 +104,7 @@ as well.

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

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

Follow the links for each of these tools for their recommended installation
Expand Down Expand Up @@ -155,7 +155,7 @@ pnpm test

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

- [Rust](https://www.rust-lang.org/en-US/) stable >= 1.56.0 and cargo, which comes with Rust
- [Rust](https://www.rust-lang.org/en-US/) stable (see `rust-toolchain.toml` for version) and cargo, which comes with Rust
- [Postgres](https://www.postgresql.org/) >= 9.5
- [OpenSSL](https://www.openssl.org/) >= 1.0.2k
- [diesel_cli](http://diesel.rs/guides/getting-started/) >= 2.0.0 and < 3.0.0
Expand Down
7 changes: 0 additions & 7 deletions docs/FRONTEND.md

This file was deleted.

Loading