-
Notifications
You must be signed in to change notification settings - Fork 274
Docs upgrade #3370
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
base: main
Are you sure you want to change the base?
Docs upgrade #3370
Changes from 22 commits
23df58c
1b63cfa
1c44cc3
df3d831
093166a
b3a7e7a
6931709
1f4a3e8
093c8a1
86426d5
5ba79a9
69d5cee
7a8e2ca
54ad8fa
c7e924f
7159a17
e2e8046
111ec35
0ed332a
827045f
38c1f66
6fdec86
34ebd69
7865e34
b8ba0d8
46af9f6
16fa6ec
3bda1c8
b709d31
c851135
474d278
e09f240
ec59373
744389a
76cde07
2248296
fc6e77d
4495c2f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,9 @@ | ||
#  | ||
|
||
## Modrinth App | ||
## Modrinth App (Theseus) | ||
|
||
The Modrinth App is a desktop application for managing your Minecraft mods. It is built with [Tauri](https://tauri.app/) and [Vue](https://vuejs.org/). | ||
[Theseus](https://modrinth.com/app) is Modrinth's Minecraft launcher that lets users play with any projects like mods, shaders and modpacks aviable on [Modrinth](https://modrinth.com/). | ||
T1xx1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If you're not a developer and you've stumbled upon this repository, you can download the latest release of the app from the [Modrinth website](https://modrinth.com/app). | ||
|
||
## Development | ||
|
||
### Pre-requisites | ||
|
||
Before you begin, ensure you have the following installed on your machine: | ||
|
||
- [Node.js](https://nodejs.org/en/) | ||
- [pnpm](https://pnpm.io/) | ||
- [Rust](https://www.rust-lang.org/tools/install) | ||
- [Tauri](https://v2.tauri.app/start/prerequisites/) | ||
|
||
### Setup | ||
|
||
Follow these steps to set up your development environment: | ||
|
||
```bash | ||
pnpm install | ||
pnpm app:dev | ||
``` | ||
|
||
You should now have a development build of the app running with hot-reloading enabled. Any changes you make to the code will automatically refresh the app. | ||
Read more about this projects and how to contribute to it on the [theseus contributing page](https://docs.modrinth.com/contributing/theseus/). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,5 @@ | ||
# Modrinth Documentation | ||
# Modrinth docs | ||
|
||
Welcome to the Modrinth documentation! | ||
Welcome to the Modrinth documentation repository! | ||
|
||
## Development | ||
|
||
### Pre-requisites | ||
|
||
Before you begin, ensure you have the following installed on your machine: | ||
|
||
- [Node.js](https://nodejs.org/en/) | ||
- [pnpm](https://pnpm.io/) | ||
|
||
### Setup | ||
|
||
Follow these steps to set up your development environment: | ||
|
||
```bash | ||
pnpm install | ||
pnpm docs:dev | ||
``` | ||
|
||
You should now have a development build of the documentation site running with hot-reloading enabled. Any changes you make to the code will automatically refresh the browser. | ||
Read more about the project and how to contribute on the [docs documentation page](https://github.com/modrinth/code/blob/main/CONTRIBUTING.md). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Ariadne | ||
description: Ariadne contributing guide | ||
--- | ||
|
||
The codebase is kept in Modrinth's [monorepo](https://github.com/modrinth/code). You can find it in the [`packages/ariadne`](https://github.com/modrinth/code/tree/main/packages/ariadne) directory. | ||
|
||
Work in progress... | ||
Comment on lines
+1
to
+8
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no ariadne specific setup, doesn't really need it's own page imo. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I haven't found any content about Aridne the project doesn't even have a readme in the monorepo |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Daedalus (Metadata service) | ||
description: Daedalus contributing guide | ||
--- | ||
|
||
import { Steps } from '@astrojs/starlight/components'; | ||
|
||
[Daedalus](https://github.com/modrinth/code/tree/main/packages/daedalus) is a library providing model structs and methods for requesting and parsing things from Minecraft and other mod loaders meta APIs. | ||
|
||
The codebase is kept in Modrinth's [monorepo](https://github.com/modrinth/code). | ||
|
||
## Architecture | ||
|
||
Daedalus is split up into two parts: | ||
|
||
- [`packages/daedalus`](https://github.com/modrinth/code/tree/main/apps/daedalus_client): The library holding all the core logic for the service | ||
- [`apps/daedalus_client`](https://github.com/modrinth/code/tree/main/apps/daedalus_client): The service worker that runs in the background and handles requests | ||
T1xx1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Ready to open a PR? | ||
|
||
<Steps> | ||
|
||
1. Open a pull request on the [monorepo repository](https://github.com/modrinth/code) | ||
T1xx1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
</Steps> |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: Docs | ||
description: Docs contributing guide | ||
--- | ||
|
||
import { Steps } from '@astrojs/starlight/components'; | ||
|
||
Modrinth Docs is the site you are looking at right now. It's here to help us work with Modrinth's projects and provide various information. | ||
|
||
The Docs are built using [Astro](https://astro.build) a content focused framework and the [Starlight](https://starlight.astro.build) integration specifically designed for documentation sites. | ||
T1xx1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The codebase is kept in Modrinth's [monorepo](https://github.com/modrinth/code). You can find it in the [`/apps/docs`](https://github.com/modrinth/code/tree/main/apps/docs) directory. | ||
|
||
## Setup | ||
|
||
<Steps> | ||
|
||
1. Follow [Getting started](/contributing/getting-started#installation) guide | ||
|
||
2. Start the development server from the root of the monorepo by running | ||
```bash | ||
pnpm run docs:dev | ||
``` | ||
|
||
or inside the docs directory, as it doesn't rely on any internal package to be built, by running | ||
```bash | ||
pnpm run dev | ||
``` | ||
|
||
2. Open you browser at [http://localhost:4321](http://localhost:4321) | ||
T1xx1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
</Steps> | ||
|
||
Pages are written using [Markdown](https://www.markdownguide.org/basic-syntax) and [MDX](https://mdxjs.com) and are stored in the `/src/content/docs` directory. | ||
The [Labrinth API docs](/api) are auto generated with [starlight-openapi](https://github.com/HiDeoo/starlight-openapi) from the `/public/openapi.yaml` file. | ||
|
||
|
||
## Ready to open a PR? | ||
|
||
<Steps> | ||
|
||
1. While there is no linting requirement, we do ask that you quickly check your code before opening a pull request. | ||
|
||
1. Open a pull request on the [monorepo repository](https://github.com/modrinth/code) | ||
T1xx1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
</Steps> |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
title: Getting started | ||
description: Setup your environment to contribute to Modrinth | ||
sidebar: | ||
order: 1 | ||
--- | ||
|
||
import { Steps } from '@astrojs/starlight/components'; | ||
|
||
Most of Modrinth's code is in our [monorepo](https://github.com/modrinth/code) which is powered by [Turborepo](https://turborepo.org). | ||
Modrinth projects are written using languages like [Rust](https://www.rust-lang.org), [Java](https://www.java.com) and frameworks like [Nuxt](https://nuxtjs.org) and [Astro](https://astro.build). | ||
|
||
## Prerequisites | ||
- [Node](https://nodejs.org) installed on your machine | ||
- [Pnpm](https://pnpm.io) installed on your machine | ||
|
||
Some projects may require additional tooling and setups and they will be specified in their respective pages. | ||
|
||
## Installation | ||
|
||
<Steps> | ||
|
||
1. Fork Modrinth's [monorepo](https://github.com/modrinth/code) from GitHub | ||
|
||
:::note | ||
Please be awere and read about our [copying guidelines](https://github.com/modrinth/code/blob/main/COPYING.md) regarding some content you'll find in the monorepo | ||
::: | ||
|
||
2. Open the monorepo with your preferred code editor | ||
|
||
2. Install the dependencies by running | ||
```bash | ||
pnpm install | ||
``` | ||
|
||
</Steps> | ||
|
||
## Projects | ||
|
||
Project-specific documentation pages: | ||
|
||
Apps: | ||
- [Daedalus (Metadata service)](/contributing/daedalus) | ||
- [Docs](/contributing/docs) | ||
- [Knossos (Frontend)](/contributing/knossos) | ||
- [Labrinth (API)](/contributing/labrinth) | ||
- [Theseus (Modrinth App)](/contributing/theseus) | ||
|
||
Packages: | ||
- [Ariadne](/contributing/ariadne) | ||
- [Omorphia (Assets)](/contributing/assets) | ||
- [Minotaur (Gradle plugin)](/contributing/minotaur) | ||
- [Ui](/contributing/ui) | ||
- [Utils](/contributing/utils) | ||
|
||
Modrinth developers are silly so they decided to name their projects after greek mitology lore |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think this generally flows better, and includes the copying guidelines
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I, of course, mentioned the copying guidelines and linked it in the getting started page when you follow instructions on how to setup the monorepo and I think is better than the readme which is just a presentation of the repository