feat(docs): General documentation improvements (OAuth documentation, docs meta) (#2855)

* feat: All good Docs things under the sun (favicon, oauth2, docs meta)

* Remove favicon changes (already fixed in other PR)

Signed-off-by: worldwidepixel <58098422+worldwidepixel@users.noreply.github.com>

---------

Signed-off-by: worldwidepixel <58098422+worldwidepixel@users.noreply.github.com>
Co-authored-by: Geometrically <18202329+Geometrically@users.noreply.github.com>
This commit is contained in:
worldwidepixel 2024-12-10 12:26:46 -08:00 committed by GitHub
parent 7d480ffbd6
commit eff3189ded
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 347 additions and 263 deletions

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,25 @@
---
title: Docs
description: Guide for contributing to Modrinth's developer documentation
---
This project is part of our [monorepo](https://github.com/modrinth/code). You can find it in the `apps/docs` directory.
[Docs] are the very site you are looking at right now.
They are here to help developers and contributors work with Modrinth's codebase and API.
To set up a development environment, you will need to install [pnpm] and run the following commands:
```bash
pnpm install
pnpm run docs:dev
```
When ready, you will have a hot-reloading environment of the docs site running on port 4321.
#### Ready to open a PR?
While there is no linting requirement on Docs, we do ask that you quickly check your writing before contributing.
[docs]: https://github.com/modrinth/code/tree/main/apps/docs
[pnpm]: https://pnpm.io

View File

@ -32,15 +32,13 @@ If you wish to contribute code to a specific project, here's the place to start.
Most of Modrinth's code is in our monorepo, which you can find [here](https://github.com/modrinth/code). Our monorepo is powered by [Turborepo](https://turborepo.org).
Follow the project-specific instructions below to get started:
- [Knossos (frontend)](/contributing/knossos)
- [Theseus (Modrinth App)](/contributing/theseus)
- [Minotaur (Gradle plugin)](/contributing/minotaur)
- [Labrinth (API/backend)](/contributing/labrinth)
- [Daedalus (Metadata service)](/contributing/daedalus)
### Documentation
The [documentation](https://github.com/modrinth/docs) (which you are reading right now!) is the place to find any and all general information about Modrinth and its API. The instructions are largely the same as [knossos](#knossos-frontend), except that the docs have no lint.
- [Docs (Developer/Contributor Documentation)](/contributing/docs)
[Discord]: https://discord.modrinth.com
[GitHub]: https://github.com/modrinth
@ -48,5 +46,6 @@ The [documentation](https://github.com/modrinth/docs) (which you are reading rig
[labrinth]: https://github.com/modrinth/labrinth
[theseus]: https://github.com/modrinth/theseus
[minotaur]: https://github.com/modrinth/minotaur
[docs]: https://github.com/modrinth/code/tree/main/apps/docs
[Rust]: https://www.rust-lang.org/tools/install
[pnpm]: https://pnpm.io
[pnpm]: https://pnpm.io

View File

@ -3,7 +3,7 @@ title: Knossos (Frontend)
description: Guide for contributing to Modrinth's frontend
---
This project is our [monorepo](https://github.com/modrinth/code). You can find the frontend in the `apps/frontend` directory.
This project is part of our [monorepo](https://github.com/modrinth/code). You can find it in the `apps/frontend` directory.
[knossos] is the Nuxt.js frontend. You will need to install [pnpm] and run the standard commands:
@ -32,4 +32,4 @@ If you're prepared to contribute by submitting a pull request, ensure you have m
- `pnpm run fix` has been run.
[knossos]: https://github.com/modrinth/code/tree/main/apps/frontend
[pnpm]: https://pnpm.io
[pnpm]: https://pnpm.io

View File

@ -3,6 +3,7 @@ title: Labrinth (API)
description: Guide for contributing to Modrinth's backend
---
This project is part of our [monorepo](https://github.com/modrinth/code). You can find it in the `apps/labrinth` directory.
[labrinth] is the Rust-based backend serving Modrinth's API with the help of the [Actix](https://actix.rs) framework. To get started with a labrinth instance, install docker, docker-compose (which comes with Docker), and [Rust]. The initial startup can be done simply with the command `docker-compose up`, or with `docker compose up` (Compose V2 and later). That will deploy a PostgreSQL database on port 5432 and a MeiliSearch instance on port 7700. To run the API itself, you'll need to use the `cargo run` command, this will deploy the API on port 8000.

View File

@ -3,7 +3,7 @@ title: Theseus (Modrinth App)
description: Guide for contributing to Modrinth's desktop app
---
This project is our [monorepo](https://github.com/modrinth/code).
This project is part of our [monorepo](https://github.com/modrinth/code). You can find it in the `apps/app` directory.
[theseus] is the Tauri-based launcher that lets users conveniently play any mod or modpack on Modrinth. It uses the Rust-based Tauri as the backend and Vue.js as the frontend. To get started, install [pnpm], [Rust], and the [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/) for your system. Then, run the following commands:
@ -19,6 +19,7 @@ You can use `pnpm run lint` to find any eslint problems, and `pnpm run fix` to t
### Theseus Architecture
Theseus is split up into three parts:
- `apps/app-frontend`: The Vue.JS frontend for the app
- `packages/app-lib`: The library holding all the core logic for the desktop app
- `apps/app`: The Tauri-based Rust app. This primarily wraps around the library with some additional logic for Tauri.
@ -40,4 +41,4 @@ If you're prepared to contribute by submitting a pull request, ensure you have m
[theseus]: https://github.com/modrinth/code/tree/main/apps/app
[Rust]: https://www.rust-lang.org/tools/install
[pnpm]: https://pnpm.io
[pnpm]: https://pnpm.io