aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-10-16 18:36:42 +0200
committerGitHub <noreply@github.com>2023-10-16 18:36:42 +0200
commit9bbcc21affe7a2b787c5a8cfb64f416cf226a0fd (patch)
treeff33ae7a18b2abab6faa65a0233f6a29b166bf24 /CONTRIBUTING.md
parent6a55173f0e2c66488aa264d02363db41fb0e1213 (diff)
downloaddokka-9bbcc21affe7a2b787c5a8cfb64f416cf226a0fd.tar.gz
dokka-9bbcc21affe7a2b787c5a8cfb64f416cf226a0fd.tar.bz2
dokka-9bbcc21affe7a2b787c5a8cfb64f416cf226a0fd.zip
Update Dokka's references to 1.9.10 (#3210)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f5b60bc1..1dba67f5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -23,9 +23,9 @@ Bug reports, feature requests and questions are welcome. Submit issues [here](ht
## Submitting PRs
-Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.0/developer_guide/introduction/) documentation
-which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.0/developer_guide/workflow/) and
-[Dokka's architecture](https://kotlin.github.io/dokka/1.9.0/developer_guide/architecture/architecture_overview/),
+Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.10/developer_guide/introduction/) documentation
+which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.10/developer_guide/workflow/) and
+[Dokka's architecture](https://kotlin.github.io/dokka/1.9.10/developer_guide/architecture/architecture_overview/),
which can help you understand how to achieve what you want and where to look.
All development (both new features and bugfixes) takes place in the `master` branch, it contains sources for the next
@@ -61,10 +61,10 @@ Unit tests which are run as part of `build` should not take much time, but you c
### Use/test locally built Dokka
Below you will find a bare-bones instruction on how to use and test locally built Dokka. For more details and examples,
-visit [Workflow](https://kotlin.github.io/dokka/1.9.0/developer_guide/workflow/) topic.
+visit [Workflow](https://kotlin.github.io/dokka/1.9.10/developer_guide/workflow/) topic.
1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version.
- For instance, you can set it to something like `1.9.0-my-fix-SNAPSHOT`.
+ For instance, you can set it to something like `1.9.10-my-fix-SNAPSHOT`.
2. Publish it to Maven Local (`./gradlew publishToMavenLocal`)
3. In the project for which you want to generate documentation add Maven Local as a buildscript/dependency
repository (`mavenLocal()`)
@@ -72,7 +72,7 @@ visit [Workflow](https://kotlin.github.io/dokka/1.9.0/developer_guide/workflow/)
```kotlin
plugins {
- id("org.jetbrains.dokka") version "1.9.0-my-fix-SNAPSHOT"
+ id("org.jetbrains.dokka") version "1.9.10-my-fix-SNAPSHOT"
}
```