From f4c39a39d0abb2347e3bd1fac4ceca48304e016d Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 30 Mar 2025 14:28:06 +0200 Subject: [PATCH] docs: update documentation for monorepo README: add tips and additional resources --- README.md | 5 +++-- docs/src/development-guidelines/monorepo.md | 6 ++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 65f21f16..e4b7f84c 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,9 @@ Simple, lightweight and feature-rich plugins for Minecraft servers. ## Modules -> [!CAUTION] -> The monorepo is still work in progress. Expect breaking changes and incomplete documentation. +> [!TIP] +> Read the [monorepo.md](docs/src/development-guidelines/monorepo.md) for more information about the monorepo. +> Here is a blog article about why we use a monorepo: [why-monorepo.md](docs/src/blog/why-monorepo.md). Plugins: - fancynpcs: create and manage fancy looking npcs ([old repository](https://github.com/FancyMcPlugins/FancyNpcs)) diff --git a/docs/src/development-guidelines/monorepo.md b/docs/src/development-guidelines/monorepo.md index eaa6ed30..749306f2 100644 --- a/docs/src/development-guidelines/monorepo.md +++ b/docs/src/development-guidelines/monorepo.md @@ -11,6 +11,12 @@ order: 8 A monorepo (monolithic repository) is a version control strategy where multiple related projects, such as Minecraft plugins and libraries, reside within a single repository. Instead of maintaining separate repositories for each plugin or library, all codebases share the same version control system, dependencies, and development workflow. +Read more about monorepos there: +- https://monorepo.tools/ +- https://medium.com/@lewimuchiri/setting-up-a-gradle-monorepo-with-spring-boot-and-version-catalogs-41fdf1112dac +- https://dev.to/scorsi/why-i-choose-to-use-a-mono-repo-for-a-very-large-project-hkp +- https://docs.gradle.org/current/userguide/intro_multi_project_builds.html + ## Benefits of a Monorepo - **Code Reuse**: Share common libraries between plugins without duplication.