diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-03-06 13:12:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-06 13:12:14 +0100 |
| commit | ded804e5772399f1495016d598573cb20b673b58 (patch) | |
| tree | 5c10a79c464c8a08764f0080d57c48476a5889ce /CONTRIBUTING.md | |
| parent | dca5c3184b22b6efe0626b278f01711118fcaf0d (diff) | |
| download | dokka-ded804e5772399f1495016d598573cb20b673b58.tar.gz dokka-ded804e5772399f1495016d598573cb20b673b58.tar.bz2 dokka-ded804e5772399f1495016d598573cb20b673b58.zip | |
Update Dokka references to 1.8.10 (#2898)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a19a9529..4a8dde56 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.7.20/developer_guide/introduction/) documentation -which goes over the development [Workflow](https://kotlin.github.io/dokka/1.7.20/developer_guide/workflow/) and -[Dokka's architecture](https://kotlin.github.io/dokka/1.7.20/developer_guide/architecture/architecture_overview/), +Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.8.10/developer_guide/introduction/) documentation +which goes over the development [Workflow](https://kotlin.github.io/dokka/1.8.10/developer_guide/workflow/) and +[Dokka's architecture](https://kotlin.github.io/dokka/1.8.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 @@ -59,10 +59,10 @@ Unit tests which are run as part of `build` should not take much time, but you c ### Using/testing 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.7.20/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/1.8.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.7.20-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.8.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()`) @@ -70,7 +70,7 @@ visit [Workflow](https://kotlin.github.io/dokka/1.7.20/developer_guide/workflow/ ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.8.10-my-fix-SNAPSHOT" } ``` |