Skip to content

Docs: More description at how to set up the development environment #7447

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.

Sign up for GitHub

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

Closed
fegmbh-rrg wants to merge 2 commits into from
+6 −1
Closed

Docs: More description at how to set up the development environment #7447

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f12f732
Update development setup instructions in docs
fegmbh-rrg Sep 8, 2026
d8081d7
Enhance local docs access with hyperlink
fegmbh-rrg Sep 8, 2026
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: 6 additions & 1 deletion apps/docs/src/content/docs/contributing/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,23 @@ This project is part of our [monorepo](https://github.com/modrinth/code). You ca
[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:
To set up a development environment, you will need to install [pnpm] and [git], if you haven't already, and run the following commands:

```bash
git clone https://github.com/modrinth/code.git modrinth
cd "modrinth"
pnpm install
pnpm run docs:dev
```

When ready, you will have a hot-reloading environment of the docs site running on port 4321.
To open it up, enter http://localhost:4321 on your Browser, or click [here].

## 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
[git]: https://git-scm.com/
[here]: http://localhost:4321/