From c1abde5ec806bc7ade917f9fbc6fce4acde68bd1 Mon Sep 17 00:00:00 2001 From: "Daniel A. A. Pelsmaeker" Date: Sat, 6 Jul 2024 19:57:19 +0200 Subject: [PATCH] Add develop documentation --- docs/content/develop/adding-dependencies.md | 11 +++++++++++ docs/content/develop/index.md | 7 +++++++ docs/mkdocs.yml | 3 +++ 3 files changed, 21 insertions(+) create mode 100644 docs/content/develop/adding-dependencies.md create mode 100644 docs/content/develop/index.md diff --git a/docs/content/develop/adding-dependencies.md b/docs/content/develop/adding-dependencies.md new file mode 100644 index 0000000..0e1c4d0 --- /dev/null +++ b/docs/content/develop/adding-dependencies.md @@ -0,0 +1,11 @@ +--- +title: "Adding Dependencies" +--- +# Adding Dependencies +To add a dependency: + +1. Modify the `gradle/libs.versions.toml` file and add the dependency to the correct section (or create a new section).\ + Consult the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format) for more information on the `libs.versions.toml` file format. +2. Also mention the dependency in `example/build.gradle.kts`. +3. If the dependency is a Spoofax dependency (a library, application, or language that is part of Spoofax), also add the dependency to `platform/build.gradle.kts`. + diff --git a/docs/content/develop/index.md b/docs/content/develop/index.md new file mode 100644 index 0000000..f5a79ca --- /dev/null +++ b/docs/content/develop/index.md @@ -0,0 +1,7 @@ +--- +title: "Develop" +--- +# Develop +Development information. + +- [Adding dependencies](./adding-dependencies.md) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 61b6ceb..20aa09a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -11,6 +11,9 @@ edit_uri: https://github.com/metaborg/gitonium/edit/main/docs nav: - Home: - index.md + - Develop: + - develop/index.md + - develop/adding-dependencies.md theme: name: material