Skip to content

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

Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
23df58c
change: reorder sidebar labyrinth docs first
T1xx1 Mar 3, 2025
1b63cfa
change: contributing overview
T1xx1 Mar 3, 2025
1c44cc3
change(docs): upgrade docs page
T1xx1 Mar 6, 2025
df3d831
feat(docs): contributing page overview
T1xx1 Mar 7, 2025
093166a
change(docs): upgrade knossos page
T1xx1 Mar 7, 2025
b3a7e7a
change(docs): upgrade labrinth page
T1xx1 Mar 7, 2025
6931709
change(docs): upgrade minotaur page
T1xx1 Mar 7, 2025
1f4a3e8
change(docs): upgrade theseus page
T1xx1 Mar 7, 2025
093c8a1
fix(docs): typos & structure
T1xx1 Mar 7, 2025
86426d5
change(docs): upgrade daedalus page
T1xx1 Mar 7, 2025
5ba79a9
feat(docs): add bluesky social
T1xx1 Mar 7, 2025
69d5cee
change(docs): pages format
T1xx1 Mar 7, 2025
7a8e2ca
change(docs): upgrade index page
T1xx1 Mar 7, 2025
54ad8fa
feat(docs): overview page
T1xx1 Mar 7, 2025
c7e924f
change(docs): refactor
T1xx1 Mar 7, 2025
7159a17
feat(docs): add missing packages pages
T1xx1 Mar 7, 2025
e2e8046
change(docs): pages content
T1xx1 Mar 7, 2025
111ec35
change: update project readmes
T1xx1 Mar 8, 2025
0ed332a
change: update monorepo readme
T1xx1 Mar 8, 2025
827045f
change: good content
T1xx1 Mar 8, 2025
38c1f66
change(docs): links format
T1xx1 Mar 8, 2025
6fdec86
change(docs): format
T1xx1 Mar 8, 2025
34ebd69
change: rm assets, ui and utils pages
T1xx1 Mar 8, 2025
7865e34
change(docs): refactor docs overview
T1xx1 Mar 8, 2025
b8ba0d8
change(docs): refer to Labrinth as API spec
T1xx1 Mar 8, 2025
46af9f6
Update apps/labrinth/README.md
T1xx1 Mar 8, 2025
16fa6ec
Update apps/docs/src/content/docs/index.mdx
T1xx1 Mar 8, 2025
3bda1c8
Update apps/docs/src/content/docs/contributing/minotaur.mdx
T1xx1 Mar 8, 2025
b709d31
Update apps/docs/src/content/docs/contributing/docs.mdx
T1xx1 Mar 8, 2025
c851135
fix(docs): numbering
T1xx1 Mar 8, 2025
474d278
fix(docs): numbering and typo
T1xx1 Mar 8, 2025
e09f240
Update apps/docs/src/content/docs/contributing/daedalus.mdx
T1xx1 Mar 8, 2025
ec59373
fix(docs): typos
T1xx1 Mar 8, 2025
744389a
change(docs): refect of Theseus as Modrinth App
T1xx1 Mar 8, 2025
76cde07
Merge branch 'main' into upgrade-docs
T1xx1 Apr 19, 2025
2248296
change: update after changes
T1xx1 May 16, 2025
fc6e77d
Merge branch 'main' into upgrade-docs
T1xx1 May 16, 2025
4495c2f
fix
T1xx1 May 16, 2025
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
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,13 @@

## Modrinth Monorepo

Welcome to the Modrinth Monorepo, the primary codebase for the Modrinth web interface and app. It contains ![Lines](https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/modrinth/olympus/badge?logoColor=white&color=black&label=) lines of code and has ![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=black&label=) contributors!
Welcome to the Modrinth Monorepo, the primary codebase for Modrinth projects. It contains ![Lines](https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/modrinth/olympus/badge?logoColor=white&color=black&label=) lines of code and has ![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=black&label=) contributors!

If you're not a developer and you've stumbled upon this repository, you can access the web interface on the [Modrinth website](https://modrinth.com) and download the latest release of the app [here](https://modrinth.com/app).

## Development
## Development and contributing

This repository contains two primary packages. For detailed development information, please refer to their respective READMEs:

- [Web Interface](apps/frontend/README.md)
- [Desktop App](apps/app/README.md)

## Contributing

We welcome contributions! Before submitting any contributions, please read our [contributing guidelines](https://docs.modrinth.com/contributing/getting-started/).

If you plan to fork this repository for your own purposes, please review our [copying guidelines](COPYING.md).
Comment on lines -25 to -27
Copy link
Contributor

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

Copy link
Contributor Author

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

You can read more about the codebase and how to contribute to it on the [contributing documentation page](https://docs.modrinth.com/contributing/modrinth/).

## Security

Expand Down
26 changes: 3 additions & 23 deletions apps/app/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,9 @@
# ![Modrinth App](/.github/assets/app_cover.png)

## 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/).

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/).
4 changes: 3 additions & 1 deletion apps/daedalus_client/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Daedalus
# Daedalus (Metadata service)

Daedalus is a powerful tool which queries and generates metadata for the Minecraft (and other games in the future!) game
and mod loaders for:
Expand All @@ -8,3 +8,5 @@ and mod loaders for:
- Reliability (Provides a versioning system which ensures no breakage with updates)

Daedalus supports the original Minecraft data and reposting for the Forge, Fabric, Quilt, and NeoForge loaders.

Read more about this projects and how to contribute to it on the [Daedalus contributing page](https://docs.modrinth.com/contributing/daedalus/).
24 changes: 3 additions & 21 deletions apps/docs/README.md
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).
10 changes: 6 additions & 4 deletions apps/docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ export default defineConfig({
baseUrl: 'https://github.com/modrinth/code/edit/main/apps/docs/',
},
social: {
blueSky: 'https://bsky.app/profile/modrinth.com',
github: 'https://github.com/modrinth/code',
discord: 'https://discord.modrinth.com',
'x.com': 'https://x.com/modrinth',
mastodon: 'https://floss.social/@modrinth',
threads: 'https://threads.net/@modrinth',
'x.com': 'https://x.com/modrinth'
},
logo: {
light: './src/assets/light-logo.svg',
Expand All @@ -34,18 +35,19 @@ export default defineConfig({
starlightOpenAPI([
{
base: 'api',
label: 'Modrinth API',
label: 'Labrinth (API)',
schema: './public/openapi.yaml',
},
]),
],
sidebar: [
{ slug: 'overview' },
// Add the generated sidebar group to the sidebar.
...openAPISidebarGroups,
{
label: 'Contributing to Modrinth',
autogenerate: { directory: 'contributing' },
},
// Add the generated sidebar group to the sidebar.
...openAPISidebarGroups,
],
}),
],
Expand Down
8 changes: 8 additions & 0 deletions apps/docs/src/content/docs/contributing/ariadne.mdx
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
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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

4 changes: 0 additions & 4 deletions apps/docs/src/content/docs/contributing/daedalus.md

This file was deleted.

25 changes: 25 additions & 0 deletions apps/docs/src/content/docs/contributing/daedalus.mdx
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

## Ready to open a PR?

<Steps>

1. Open a pull request on the [monorepo repository](https://github.com/modrinth/code)

</Steps>
25 changes: 0 additions & 25 deletions apps/docs/src/content/docs/contributing/docs.md

This file was deleted.

46 changes: 46 additions & 0 deletions apps/docs/src/content/docs/contributing/docs.mdx
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.

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)

</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)

</Steps>
51 changes: 0 additions & 51 deletions apps/docs/src/content/docs/contributing/getting-started.md

This file was deleted.

56 changes: 56 additions & 0 deletions apps/docs/src/content/docs/contributing/getting-started.mdx
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
35 changes: 0 additions & 35 deletions apps/docs/src/content/docs/contributing/knossos.md

This file was deleted.

Loading