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 34 commits into
base: main
Choose a base branch
from
Open

Docs upgrade #3370

wants to merge 34 commits into from

Conversation

T1xx1
Copy link
Contributor

@T1xx1 T1xx1 commented Mar 8, 2025

Documentation general update & related

Consider merging #3342 first (will probably require merge from main)

  • chore: update docs deps/pkgs (resolves #3150) #3326
  • Use mdx files instead of md files to allow the use of components from Starlight
  • Refactor and restructure project pages with a better format and consistency between them
  • Add links to the docs pages from each project readmes
  • Added general docs overview page
  • Added contributing getting started page with detailed information about how to setup the monorepo and also additional setups in each project pages
  • Added Omorphia page
  • Added ariadne, ui and utils page with no actual content
  • Added Bluesky social link

Copy link
Contributor

@Erb3 Erb3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for lots of nits

Comment on lines +1 to +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...
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

Comment on lines -25 to -27
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).
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants