diff options
author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-08-04 18:59:28 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-08-04 18:59:28 +0200 |
commit | f7bd2ce1a5ef194643b078bd11a90fdf9b389c2b (patch) | |
tree | 2f26d61ed1f90f5a2c3405b70c651607f97506d7 /docs-developer/src/doc/docs/developer_guide/introduction.md | |
parent | b559131ddda8efea3394a0ea641460c4189769db (diff) | |
download | dokka-f7bd2ce1a5ef194643b078bd11a90fdf9b389c2b.tar.gz dokka-f7bd2ce1a5ef194643b078bd11a90fdf9b389c2b.tar.bz2 dokka-f7bd2ce1a5ef194643b078bd11a90fdf9b389c2b.zip |
Update Developer Guides (#3088)
Diffstat (limited to 'docs-developer/src/doc/docs/developer_guide/introduction.md')
-rw-r--r-- | docs-developer/src/doc/docs/developer_guide/introduction.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs-developer/src/doc/docs/developer_guide/introduction.md b/docs-developer/src/doc/docs/developer_guide/introduction.md new file mode 100644 index 00000000..627afa3a --- /dev/null +++ b/docs-developer/src/doc/docs/developer_guide/introduction.md @@ -0,0 +1,22 @@ +# Developer guides + +The purpose of the Developer guides documentation is to get you acquainted with Dokka's internals so that you can +start developing your own plugins or contributing features and fixes to Dokka itself. + +If you want to start hacking on Dokka right away, the only thing you need to be aware of is the +[general workflow](workflow.md): it will teach you how to build, debug and test Dokka locally. + +[CONTRIBUTING.md](https://github.com/Kotlin/dokka/blob/master/CONTRIBUTING.md) contains information that can be useful +if you want to contribute to Dokka. + +If you want to get into plugin development quick, see +[Introduction to plugin development](plugin-development/introduction.md). + +If you have time to spare and want to know more about Dokka's internals, its architecture and capabilities, follow +[Architecture overview](architecture/architecture_overview.md) and subsequent sections inside `Internals`. + +Having read through all the developer guides, you'll have a pretty good understanding of Dokka and how to develop +for it. + +If you have any questions, feel free to get in touch with maintainers via [Slack](community/slack.md) or +[GitHub](https://github.com/kotlin/dokka). |